Skip to main content

APIs

Overview

FA’s APIs provide you with programmatic access to the data you have stored in FA, allowing you to build your own solutions on top of your portfolio management system. FA’s APIs allow you to extensively manage the communication between FA and the other applications you develop and maintain.

Functionality

Integrate FA with your own platforms and services through APIs

  • Search, add, and modify your data via API calls - access data in FA through standard APIs. The fundamental data types (contacts, portfolios, securities, transactions, and trade orders) provide you with different options to search and modify data.

  • Generate and fetch reports – get reports for specific contacts, portfolios, transactions, or trade orders in JSReport.

  • Browse and try out FA APIs – browse documentation for the available GraphQL endpoints and define queries using interactive developer tools: see API integrations in FA Developer guide.

Manage data access

  • Restrict data access - define whether or not a given user has access to a given portfolio's or contact's information.

Supported formats

FA offers APIs based on two technologies – GraphQL and REST. We recommend using GraphQL APIs – they are constantly updated and provide access to all necessary data and functionality. Our REST APIs are in maintenance mode and are not actively developed.

GraphQL APIs

GraphQL APIs provide access to the following data:

Data type

Description

Portfolio management

APIs for fetching and modifying contacts, portfolios, accounts, securities, transactions, trade orders, and bookkeeping postings.

Documents

APIs for fetching, uploading, and deleting documents.

Analytics

APIs for fetching portfolio and security analysis data, running strategy, and portfolio performance analysis.

Reporting

APIs for fetching report data and generating standard and custom reports.

Tasks

APIs for adding, modifying, deleting, and fetching tasks from FA Back.

Fund management

APIs for interacting with fund management features.

Business rules

APIs for launching and interacting with customized processes.

Reconciliation

APIs for fetching, updating, and deleting reconciliation-related data.

REST APIs

Basic APIs

Data type

View all

Find by id

Filter

Import

Modify

Delete

Contact

X

X

X

X

X

Portfolio

Accounts

X

X

X

X

X

Bookkeeping

X

X

X

Positions

X

X

X

Security

X

X

X

X

X

Transaction

X

X

X

X

X

X

(status change)

Trade order

X

X

X

X

X

X

(status change)

Market price

X

(security id)

X

X

Profile data

X

X

X

X

X

Preferences

X

X