XEROF API Documentation

Generates a JWT token, requiring the API key, API secret, and username. The JWT token is valid for 30 minutes. If the token expires, you will need to generate a new one. Each subsequent API request will require an Authorization header with the token. If you are a new customer and do not have an API key and secret, please contact Emile Davidson at . For existing customers, please contact your assigned account manager.

Validates the provided JWT token to ensure it is authentic and not expired. The Authorization header should contain the JWT token.

Returns the list of balances available in the user's account. Each balance represents a specific asset (e.g., cryptocurrency, fiat currency) and includes information such as available amount, locked amount, and total amount.

Returns a list of all available currencies (fiat and crypto).

List Deposits

Show Deposit

Get Deposit Address (Guest)

Get Deposit Address Token (guest)

List Fee Rules

Create Fee Rule

Show Fee Rule

Update Fee Rule

Delete Fee Rule

List All Ledger Entries

Show Ledger Entries by Username

Show Ledger Deposits by Username

List Liquidities

Retrieve liquidity details by liquidity_id

List All Orders

Create Order

List Open Orders

List Order History (Closed Orders)

Get Order by ID

Get Quotes

List all providers

Get provider by ID

Get Balance Stats

Get User Stats

Get Volume Stats

Get Buying Power

Enable Trading

Disable Trading

Check Trading Status

Update Trading Password

List Withdrawals

Create Withdrawal

Show Withdrawal

Update Withdrawal

List Transfers

Create Transfer

Show Transfer

Update Transfer

Show Transfer Config

Update Transfer Config

Delete Transfer Config

List Transfer Configs

Create Transfer Config

List Users

Get User by ID

Create User or Admin

Get Wallet Stats

Get All System Wallets

Create New External Wallet

Get User Wallets

Creates a new guest user with personal information (PII). This is the first step in the widget onboarding process.

Generates a token for an existing guest user. This token is required to access protected parts of the widget and must be included in the widget URL.

Checks the status of an onramp transaction using the transaction ID (`cid`).

Get onramp transaction details by CID

Create Bank Account

List Bank Accounts