⚙️API Integrations (V5)

Learn more about OpenTrade's REST API and common integration paths.

Overview

The REST API enables users to query information on vaults, transactions, and accounts.

Versioning

The Version 5 API can be used to query vaults and accounts from both Version 4 and Version 5.

Data Schemas

There are multiple different data schemas that will be returned depending on the endpoint, vault type, and version you are querying. Each schema is documented in detail in the subsequent pages and on Swagger.

You do not need to specify the schema when calling an endpoint. The correct schema will be returned automatically depending on the endpoint, vault, and versioning you are querying.

Version / Vault Type	Schema Name
All	PoolEvent
V4 / Fixed Term	VaultAccountCTO VaultConfigurationCTO LoanOverviewCTO WithdrawalActivityCTO
V4 / Flexible Term	VaultFlexOverviewCTO VaultFlexAccountCTO VaultFlexConfigurationCTO WithdrawalActivityCTO
V5 / Dynamic	VaultDynamicOverviewCTO VaultDynamicAccountCTO VaultDynamicConfigurationCTO DynamicWithdrawalActivityCTO

API Status & Monitoring

OpenTrade monitors the APIs' statuses continuously and provides a status page which customers can access at anytime to check for and track issues, incidents, planned upgrades, and downtime.

You can access the status page here.

Authentication

The API requires an API keys to authenticate, both in sandbox and in production.

To request an API key, please inquire with your account manager.

Swagger

For the REST API, we provide a Swagger collection that enables you to review and test the API.

REST URLs (V5)

Each environment has a unique URL.

Environment	Networks	URL
Production	Ethereum, Avalanche	https://api-open-trade.io
Sandbox	Sepolia, Fuji	https://api.opentradesandbox.io

Common Use Cases

Return a list of vaults

Query a specific vault

Query a specific account

Query withdrawal activity

Get events for a vault

Get events for an account

Get historical data for a vault

Get historical data for an account