# API Integrations (V5)

## 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 on [Swagger](https://app.swaggerhub.com/apis/OpenTrade/Open-trade_api). 

{% hint style="success" %}
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. 
{% endhint %}

<table><thead><tr><th width="244.8125">Version / Vault Type</th><th>Schema Name</th><th data-hidden></th></tr></thead><tbody><tr><td><strong>All</strong></td><td><ul><li>PoolEvent</li><li>CompanyProfileCTO</li><li>CompanyProfileActionCTO</li></ul></td><td></td></tr><tr><td><strong>V4 / Fixed Term</strong> </td><td><ul><li>VaultAccountCTO</li><li>VaultConfigurationCTO</li><li>LoanOverviewCTO</li><li>WithdrawalActivityCTO</li></ul></td><td></td></tr><tr><td><strong>V4 / Flexible Term</strong> </td><td><ul><li>VaultFlexOverviewCTO</li><li>VaultFlexAccountCTO</li><li>VaultFlexConfigurationCTO</li><li>WithdrawalActivityCTO</li></ul></td><td></td></tr><tr><td><strong>V5 / Dynamic</strong></td><td><ul><li>VaultDynamicOverviewCTO</li><li>VaultDynamicAccountCTO</li><li>VaultDynamicConfigurationCTO</li><li>DynamicWithdrawalActivityCTO</li></ul></td><td></td></tr></tbody></table>

### 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.&#x20;

You can access the status page [here](https://status.opentrade.io).&#x20;

### Authentication

The API requires an API keys to authenticate, both in sandbox and in production.&#x20;

{% hint style="info" %}
To request an API key, please inquire with your account manager.&#x20;
{% endhint %}

### Swagger

For the REST API, we provide a [Swagger collection](https://app.swaggerhub.com/apis-docs/OpenTrade/open-trade_5_0_api/5.0#/) that enables you to review and test the API.&#x20;

## REST URLs (V5)

Each environment has a unique URL.&#x20;

<table><thead><tr><th width="197">Environment</th><th width="200">Networks</th><th>URL</th></tr></thead><tbody><tr><td>Production</td><td>Ethereum, Avalanche</td><td>https://api.open-trade.io</td></tr><tr><td>Sandbox</td><td>Sepolia, Fuji</td><td>https://api.opentradesandbox.io</td></tr></tbody></table>

## Common Use Cases

{% content-ref url="../version-4-integrations/api-integrations-for-flexible-term-vaults-v4/rest-api/return-a-list-of-vaults" %}
[return-a-list-of-vaults](https://sandboxdocs.opentrade.io/opentrade-sandbox/version-4-integrations/api-integrations-for-flexible-term-vaults-v4/rest-api/return-a-list-of-vaults)
{% endcontent-ref %}

{% content-ref url="../version-4-integrations/api-integrations-for-flexible-term-vaults-v4/rest-api/query-a-specific-vault" %}
[query-a-specific-vault](https://sandboxdocs.opentrade.io/opentrade-sandbox/version-4-integrations/api-integrations-for-flexible-term-vaults-v4/rest-api/query-a-specific-vault)
{% endcontent-ref %}

{% content-ref url="../version-4-integrations/api-integrations-for-flexible-term-vaults-v4/rest-api/query-a-specific-account" %}
[query-a-specific-account](https://sandboxdocs.opentrade.io/opentrade-sandbox/version-4-integrations/api-integrations-for-flexible-term-vaults-v4/rest-api/query-a-specific-account)
{% endcontent-ref %}

{% content-ref url="api-integrations-v5/query-withdrawal-activity" %}
[query-withdrawal-activity](https://sandboxdocs.opentrade.io/opentrade-sandbox/version-5-integrations/api-integrations-v5/query-withdrawal-activity)
{% endcontent-ref %}

{% content-ref url="api-integrations-v5/get-events-for-a-vault" %}
[get-events-for-a-vault](https://sandboxdocs.opentrade.io/opentrade-sandbox/version-5-integrations/api-integrations-v5/get-events-for-a-vault)
{% endcontent-ref %}

{% content-ref url="api-integrations-v5/get-events-for-an-account" %}
[get-events-for-an-account](https://sandboxdocs.opentrade.io/opentrade-sandbox/version-5-integrations/api-integrations-v5/get-events-for-an-account)
{% endcontent-ref %}

{% content-ref url="api-integrations-v5/get-historical-data-for-a-vault" %}
[get-historical-data-for-a-vault](https://sandboxdocs.opentrade.io/opentrade-sandbox/version-5-integrations/api-integrations-v5/get-historical-data-for-a-vault)
{% endcontent-ref %}

{% content-ref url="api-integrations-v5/get-historical-data-for-an-account" %}
[get-historical-data-for-an-account](https://sandboxdocs.opentrade.io/opentrade-sandbox/version-5-integrations/api-integrations-v5/get-historical-data-for-an-account)
{% endcontent-ref %}