GET /api/v1/accounts/currency/{currency}

Returns one account belonging to the authenticated API key owner for the requested currency when that currency is enabled in the owner's effective jurisdiction.

Headers

  • X-API-KEY string Required

    Public API key issued from the Lumetrade API key management flow.

  • X-API-SECRET string Required

    API secret paired with the public API key.

Path parameters

  • currency string Required

    Currency for the account lookup.

Responses

  • 200 application/json

    Account returned successfully

    Hide response attributes Show response attributes object
    • id string

      Account id used by external account endpoints.

    • currency string

      Account currency.

    • balance number

      Available account balance.

    • lockedBalance number

      Locked account balance.

  • 404 application/json

    Account or currency was not found for the authenticated user

    Hide response attributes Show response attributes object
    • id string

      Account id used by external account endpoints.

    • currency string

      Account currency.

    • balance number

      Available account balance.

    • lockedBalance number

      Locked account balance.

GET /api/v1/accounts/currency/{currency}
curl \
 --request GET 'https://api.lumetrade.com/api/v1/accounts/currency/ZAR' \
 --header "X-API-KEY: string" \
 --header "X-API-SECRET: string"
Response examples (200)
{
  "id": "acc_8F4J2N",
  "currency": "ZAR",
  "balance": 2500,
  "lockedBalance": 0
}
Response examples (404)
{
  "id": "acc_8F4J2N",
  "currency": "ZAR",
  "balance": 2500,
  "lockedBalance": 0
}