v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB

Transfer

Get max transferable amount

Rate limit: 60 requests per 60 seconds. This is the default shared quota — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.

Returns the maximum amount the customer may transfer from the specified source account to the specified destination account.

get/api/v1/money/transferable-balance

Query parameters

sourceAccountType'trading' | 'options' | 'cash' | 'moneyFarm' required

Source account type (trading, options, or cash).

sourceAccountIdstring required

Source account identifier.

destinationAccountType'trading' | 'options' | 'cash' | 'moneyFarm' required

Destination account type (trading, options, or cash).

destinationAccountIdstring required

Destination account identifier.

Headers

x-request-idstring uuid required

Example:6be3ab99-709e-42e8-bbe6-8c5886a05e6b

A unique request identifier.

x-api-keystring password required

Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required

Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Response

Transferable amount and account identifiers for the route.

transferableAmountnumber double required

Maximum amount the user may transfer on this route in Currency.

currencystring required

ISO 4217 alphabetic currency code for transferableAmount.

amountInUsdnumber double required

transferableAmount expressed in USD for display or analytics.

exchangeRatenumber double required

Raw FX rate used to derive amountInUsd from the amount in currency.

Example response

{
  "sourceAccount": {
    "accountId": "ACC-100100"
  },
  "destinationAccount": {
    "accountId": "ACC-100100"
  },
  "transferableAmount": 1500.5,
  "currency": "USD",
  "amountInUsd": 1500.5,
  "exchangeRate": 1
}