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.
Authorizations
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
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
A unique request identifier.
"49e4adf8-1f0e-443d-b758-7b1d9fe5810b"
Query Parameters
Source account type (trading, options, or cash).
trading, options, cash, moneyFarm Source account identifier.
Destination account type (trading, options, or cash).
trading, options, cash, moneyFarm Destination account identifier.
Response
Transferable amount and account identifiers for the route.
Transferable balance for a source/destination account pair
Confirmed source account.
Confirmed destination account.
Maximum amount the user may transfer on this route in Currency.
1500.5
ISO 4217 alphabetic currency code for transferableAmount.
^[A-Z]{3}$"USD"
transferableAmount expressed in USD for display or analytics.
1500.5
Raw FX rate used to derive amountInUsd from the amount in currency.
1