> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs-v3.openfx.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Programmatic access to OpenFX v1 endpoints for market data, balances, trade execution, deposits, and withdrawals.

<Warning>
  **v1 sunsets December 31, 2026.** Migrate to v2 — see the [migration guide](/v1/migration-v1-to-v2).
</Warning>

OpenFX provides a v1 API suite for programmatic access to real-time market data, trade execution, and money movement. This guide is a directory of every v1 endpoint, grouped by domain. Each card links to the per-endpoint reference.

**Version**: v1.0.0

## Servers

OpenFX API Server:

```
https://api.openfx.com
```

## Security

### bearerAuth

* **Type**: `http`
* **Scheme**: `bearer`
* **Bearer Format**: `JWT`

See [Authentication](/v1/authentication) for how to generate a JWT bearer token.

## Download OpenAPI description

[Overview of OpenFX APIs](https://api-docs.openfx.com/_bundle/api/v1/index.yaml)

## Market data

Retrieves the list of tradable fiat and stablecoin currency pairs on the OpenFX platform.

<CardGroup cols={2}>
  <Card title="Get available markets" icon="chart-line" href="/v1/api-reference/market-data/get-available-markets">
    `GET /v1/brokerage/{orgId}/available_markets` — Access the complete list of available currency pairs, with trading limits and possible trade directions per currency.
  </Card>
</CardGroup>

## Balances

The Balance endpoints enable real-time tracking and management of currency holdings within an account.

<CardGroup cols={2}>
  <Card title="Get balances" icon="wallet" href="/v1/api-reference/balances/get-balances">
    `GET /v1/brokerage/{orgId}/balances` — View real-time balances, multi-currency holdings, available trading funds, and reconcile account positions.
  </Card>
</CardGroup>

## Trade

The Trade APIs facilitate programmatic currency exchange through a quote-then-trade workflow, with price transparency and execution at quoted rates.

<CardGroup cols={2}>
  <Card title="Generate quote" icon="bolt" href="/v1/api-reference/trade/generate-quote">
    `POST /v1/brokerage/{orgId}/generate_quote` — Create a new quote for a currency pair and amount, returning a quote ID and rate valid for 3 seconds.
  </Card>

  <Card title="Execute trade" icon="arrow-right-arrow-left" href="/v1/api-reference/trade/execute-trade">
    `POST /v1/brokerage/{orgId}/trade` — Execute a currency exchange trade using a valid quote ID. Must be called within 3 seconds of quote generation.
  </Card>

  <Card title="List trades" icon="list" href="/v1/api-reference/trade/list-trades">
    `GET /v1/brokerage/{orgId}/trades` — Return a list of all trades, including completed and pending transactions.
  </Card>

  <Card title="Get trade by ID" icon="magnifying-glass" href="/v1/api-reference/trade/get-trade-by-id">
    `GET /v1/brokerage/{orgId}/trade/{id}` — Retrieve detailed information about a specific trade by its unique identifier.
  </Card>
</CardGroup>

## Deposits

Deposit endpoints enable funding of trading accounts across multiple supported currencies and methods.

<CardGroup cols={2}>
  <Card title="List deposits" icon="arrow-down-to-bracket" href="/v1/api-reference/deposits/list-deposits">
    `GET /v1/brokerage/{orgId}/deposits` — Get a complete view of all deposits (both fiat and stablecoin) for an organization.
  </Card>
</CardGroup>

## Withdrawals

The Withdrawal APIs cover fund withdrawals for both fiat and stablecoins.

<CardGroup cols={2}>
  <Card title="List withdrawal wallets" icon="wallet" href="/v1/api-reference/withdrawals/list-withdrawal-wallets">
    `GET /v1/brokerage/{orgId}/withdrawal_addresses` — Retrieve the list of approved stablecoin withdrawal wallets for an organization.
  </Card>

  <Card title="List fiat withdrawal accounts" icon="building-columns" href="/v1/api-reference/withdrawals/list-fiat-withdrawal-accounts">
    `GET /v1/brokerage/{orgId}/fiat_withdrawal_addresses` — Retrieve all approved fiat withdrawal accounts for an organization. Paginated.
  </Card>

  <Card title="List withdrawals" icon="list" href="/v1/api-reference/withdrawals/list-withdrawals">
    `GET /v1/brokerage/{orgId}/withdrawals` — Get a complete view of all withdrawals (both fiat and stablecoin) for an organization.
  </Card>

  <Card title="Get withdrawal by ID" icon="magnifying-glass" href="/v1/api-reference/withdrawals/get-withdrawal-by-id">
    `GET /v1/brokerage/{orgId}/withdrawal/{withdrawalId}` — Retrieve detailed information about a specific withdrawal.
  </Card>

  <Card title="Initiate stablecoin withdrawal" icon="arrow-up-from-bracket" href="/v1/api-reference/withdrawals/initiate-stablecoin-withdrawal">
    `POST /v1/brokerage/{orgId}/withdrawal` — Initiate a stablecoin withdrawal to an approved wallet address.
  </Card>

  <Card title="Initiate fiat withdrawal" icon="building-columns" href="/v1/api-reference/withdrawals/initiate-fiat-withdrawal">
    `POST /v1/brokerage/{orgId}/fiat_withdrawal` — Initiate a fiat withdrawal to an approved bank account.
  </Card>
</CardGroup>