Welcome

Introduction to the Atlas API

Welcome to the Atlas developer hub from Bridge Financial Technology. You'll find comprehensive guides, examples, reference documentation and support if you get stuck.

What is Atlas?

Atlas is a platform for financial advisors and third parties they work with to automate back-office operations and deliver high fidelity, accurate data. It generates reports, runs billing, enables account management, automates client communication, and integrates into trade execution services.

We pride ourselves on high quality data. To learn more about what that means and what's available on our platform, see Data Overview.

Documentation Resources

Guides (what you're currently looking at) provide a high level overview of the API. They cover best practices, how to authenticate and use the API as well as background details.

The API Reference is a full detail of responses, expected inputs, supported http methods and possible errors for all the endpoints.

Finally, make sure to regularly check the changelog to stay up to date with new features and releases.

Base URL

Atlas API base url: https://api.bridgeft.com/v2

Versioning

The suffix of the base url refers to the major version. Atlas is currently on version 2. Changes to the major version will result from backward incompatible changes. All major version changes will be accompanied by a long migration period to allow developers to upgrade client integrations.

Best practices

The Atlas API doesn't impose any rate limits at the moment, however we may deny requests from a particular user or API key if we identify abuse or generally unacceptable consumption of data. Below are some best practices you should implement when integrating with the Atlas API:

  • Don't invoke the API from your test suite; instead, mock responses coming back from the API.
  • Implement retry behavior with exponential backoff to account for failures due to network latency or other reasons.
  • Consume and log error messages, codes and eventID values in your logs so you can better assist our development team in identifying any issues you may encounter either during development or in production.
  • Generally use the default pagination limit. The Atlas API can push large payloads of data out; make sure you're able to handle the data I/O when increasing the changing the pagination size.
  • We recommend filtering data unless you're executing a system-wide synchronization.
  • Be mindful of the number of requests you make. We recommend synchronous invocation to avoid flooding our API and receiving a 429 error message as a result.

Open API Specification

The reference documentation is generated using OpenAPI v3, otherwise known as swagger.

The OAS spec document and information about code generation support can be found under sdk clients

Support

If you run into trouble please reach out to [email protected] for assistance.