Getting Data

Learn how to retrieve accounts, orders, positions, and other data from connected brokerages.

Once the session is initialized and the user has approved read permission on a broker connection, you can retrieve account data. Here are the most common methods:

Get Accounts

Retrieve all accounts from connected brokerages:

const result = await finatic.getAccounts();

if (result.success) {
 const accounts = result.success.data; // PaginatedData - use directly as array
 console.log(`Found ${accounts.length} account(s)`);
} else {
 console.error('Failed to get accounts:', result.error);
}

Get Orders

Retrieve orders from connected brokerages:

const result = await finatic.getOrders();

if (result.success) {
 const orders = result.success.data; // PaginatedData - use directly as array
 console.log(`Found ${orders.length} order(s)`);
} else {
 console.error('Failed to get orders:', result.error);
}

Get Positions

Retrieve positions from connected brokerages:

const result = await finatic.getPositions();

if (result.success) {
 const positions = result.success.data; // PaginatedData - use directly as array
 console.log(`Found ${positions.length} position(s)`);
} else {
 console.error('Failed to get positions:', result.error);
}

Pagination

The regular methods (getAccounts(), getOrders(), getPositions()) support pagination. The response data is a PaginatedData object that behaves like an array and includes navigation methods:

result.success.data: The paginated data (use directly as an array - result.success.data[0], result.success.data.length, etc.)
result.success.data.hasMore: Boolean indicating if there are more pages available
result.success.data.nextPage(): Fetches and returns the next page (e.g., if currently on page 1 with 50 results, this fetches results 51-100)
result.success.data.prevPage(): Fetches and returns the previous page (e.g., if currently on page 2, this fetches the previous 50 results)
result.success.data.firstPage(): Fetches and returns the first page of results
result.success.data.lastPage(): Fetches and returns the last page of results

You can also use limit and offset parameters to control pagination manually.

Example with pagination navigation methods:

// Get first page (results 1-50)
const result = await finatic.getOrders({ limit: 50 });

if (result.success) {
 const firstPage = result.success.data; // PaginatedData - use as array
 console.log(`First page: ${firstPage.length} orders`);
 
 // Check if there are more pages
 if (firstPage.hasMore) {
 // Get next page (results 51-100)
 const secondPage = await firstPage.nextPage();
 console.log(`Next page: ${secondPage.length} orders`); // Go back to previous page (results 1-50) const prevPage = await secondPage.prevPage(); console.log(`Previous page: ${prevPage.length} orders`); // Jump to last page const lastPage = await firstPage.lastPage(); console.log(`Last page: ${lastPage.length} orders`); // Jump back to first page const firstPageAgain = await lastPage.firstPage(); console.log(`First page: ${firstPageAgain.length} orders`); } }
 const secondPage = nextResult.success.data;
 console.log(`Next page: ${secondPage.length} orders`);
 
 // Go back to previous page (results 1-50)
 const prevResult = await nextResult.prevPage();
 if (prevResult.success) {
 console.log(`Previous page: ${prevResult.success.data.length} orders`);
 }
 
 // Jump to last page
 const lastResult = await nextResult.lastPage();
 if (lastResult.success) {
 console.log(`Last page: ${lastResult.success.data.length} orders`);
 }
 
 // Jump back to first page
 const firstResult = await lastResult.firstPage();
 if (firstResult.success) {
 console.log(`First page: ${firstResult.success.data.length}orders`);
 }
 }
 }
}

Example with manual pagination:

// Get first page (50 results)
const page1 = await finatic.getOrders({ limit: 50, offset: 0 });

// Get second page (next 50 results)
const page2 = await finatic.getOrders({ limit: 50, offset: 50 });

Note: Each method also has a "get all" version (getAllAccounts(), getAllOrders(), getAllPositions()) that automatically handles pagination for you by fetching all pages and returning a single array with all results. Use these methods when you need all data without managing pagination manually.

Understanding the Response Format

All Finatic API methods return a consistent response format:

{
    success: {
        data: { /* your data */ },
        meta?: { /* optional metadata */ }
    },
    error: null,
    warning: null
}

In case of an error:

{
    success: null,
    error: {
        message: "Error description",
        code?: "ERROR_CODE",
        status?: 400
    },
    warning: null
}

Next Steps

Now that you've retrieved your data:

Connect Brokers - Learn how to connect brokerages to access real data
Handle Errors - Review error handling patterns for robust applications
Explore the API Reference - See all available methods in the API Reference
Try the Interactive Playground - Test the SDK in your browser with our Interactive Playground