Skip to content

Overview of OpenFX APIs (v1.0.0)

OpenFX provides a robust and secure API suite engineered for high performance and reliability, enabling programmatic access to real-time market data, trade execution, and money movement functionalities. This guide will walk through the step-by-step process of deposits, quoting, trading, settlements and monitoring using OpenFX APIs.

Overview
URL

https://www.openfx.com

OpenFX Support

support@openfx.com

Terms of Service

Languages
Servers
OpenFX API Server

https://api.sandbox.openfx.com/

MarketData

This endpoint retrieves a complete list of all tradable fiat and stablecoin currency pairs on the OpenFX platform.

Operations

Balances

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

Operations

Trade

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

Operations

Deposits

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

Operations

List deposits

Request

This endpoint is used to get a comprehensive view of all deposits (both fiat and stablecoins) done by an organization.

Security
bearerAuth
Path
orgIdstringrequired
Query
pagenumber(number)>= 1
Default 1
Example: page=1
limitnumber(number)[ 1 .. 50 ]
Default 10
Example: limit=10
currencystring
Example: currency=USD
curl -i -X GET \
  'https://api.sandbox.openfx.com/v1/brokerage/{orgId}/deposits?page=1&limit=10&currency=USD' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

success

Bodyapplication/json
statusstring
Enum"success""error"
Example: "success"
dataArray of objects or null
data[].​idstring(uuid)

Unique identifier for the deposit record

Example: "a9504caf-6888-409c-b841-da5127334070"
data[].​orgIdstring(uuid)

Unique identifier of the organization associated with the deposit

Example: "a9504caf-409c-b841-6888-da5127334070"
data[].​currencystring

Currency symbol used for the deposit

Example: "USDC"
data[].​amountnumber

Amount deposited in the specified currency

Example: 10
data[].​statusstring

Current status of the deposit — either PENDING or COMPLETED

Enum"PENDING""COMPLETED"
Example: "COMPLETED"
data[].​networkstring

Blockchain network symbol where the deposit was made

Example: "ETH"
data[].​createdAtstring

UTC Timestamp when the deposit record was created

Example: "2024-02-03T08:04:12.045Z"
data[].​transactionHashstring or null

Blockchain transaction hash associated with the deposit, if available

Example: null
data[].​commentsstring or null

Optional comments or notes associated with the deposit

Example: null
data[].​referenceIdstring or null

External reference identifier for tracking the deposit, if applicable

Example: null
messagestring
Example: "Data fetched successfully"
metaobject
meta.​paginationobject
meta.​pagination.​totalnumber
Example: 10
meta.​pagination.​startnumber
Example: 1
meta.​pagination.​endnumber
Example: 2
meta.​pagination.​pagenumber
Example: 1
meta.​pagination.​limitnumber
Example: 2
Response
application/json
{
  "status": "success",
  "data": [
    {
      "id": "6a8dff03-a99c-4b76-b65a-3900315858a2",
      "orgId": "c96183a5-2830-4606-9ae2-15dfd058872b",
      "currency": "EUR",
      "amount": 10,
      "status": "COMPLETED",
      "transactionHash": null,
      "comments": null,
      "referenceId": null,
      "network": "FIAT",
      "createdAt": "2025-02-07T13:02:29.147Z"
    },
    {
      "id": "e8329d97-c9f9-4fa2-be2e-f0b9d0db2698",
      "orgId": "c96183a5-2830-4606-9ae2-15dfd058872b",
      "currency": "EUR",
      "amount": 10,
      "status": "COMPLETED",
      "transactionHash": null,
      "comments": "Client deposit",
      "referenceId": null,
      "network": "FIAT",
      "createdAt": "2025-01-30T13:55:23.334Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "start": 1,
      "end": 2,
      "page": 1,
      "limit": 2
    }
  }
}

Withdrawals

The Withdrawal API facilitates secure fund withdrawals for both fiat and stablecoins.

Operations