Skip to main content
GET
Get max transferable amount

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"49e4adf8-1f0e-443d-b758-7b1d9fe5810b"

Query Parameters

sourceAccountType
enum<string>
required

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

Available options:
trading,
options,
cash,
moneyFarm
sourceAccountId
string
required

Source account identifier.

destinationAccountType
enum<string>
required

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

Available options:
trading,
options,
cash,
moneyFarm
destinationAccountId
string
required

Destination account identifier.

Response

Transferable amount and account identifiers for the route.

Transferable balance for a source/destination account pair

sourceAccount
object
required

Confirmed source account.

destinationAccount
object
required

Confirmed destination account.

transferableAmount
number<double>
required

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

Example:

1500.5

currency
string
required

ISO 4217 alphabetic currency code for transferableAmount.

Pattern: ^[A-Z]{3}$
Example:

"USD"

amountInUsd
number<double>
required

transferableAmount expressed in USD for display or analytics.

Example:

1500.5

exchangeRate
number<double>
required

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

Example:

1