Jump to Content
Documentation
Recipes
API Reference
Release Notes
Legal
Log In
Portal
API Reference
Log In
Portal
Documentation
Recipes
API Reference
Release Notes
Legal
Balance Subscription
Search
JUMP TO
Zero Hash API
Public
Get server time
get
CORE RESOURCES
Assets
List assets
get
Accounts
Accounts (STA)
List accounts
get
Get account
get
List account movements
get
List account run history
get
List NDOs
get
Customer Accounts (MTA)
Create customer account
post
Get account details
get
Update customer account
patch
Add tenant to customer account
post
Remove tenant from customer account
del
Add advisor to customer account
post
Remove advisor from customer account
del
Customer Account Management
Withdraw unlock customer account
post
Get customer account status reason
get
Unlock customer account
post
Withdraw lock customer account
post
Divest customer account
post
Close customer account
post
Lock customer account
post
Deposits
Digital Assets
Create deposit address
post
List deposit addresses
get
Update address owner
patch
List deposits
get
BOLT11
Create a BOLT11 invoice for deposit
post
Create a test payment for a BOLT11 deposit invoice
post
Fiat
List fiat accounts
get
UMA
Create UMA address
post
Update UMA address
patch
List UMA addresses
get
Cert only
Fund account
post
Withdrawals
Request
Create withdrawal request
post
Get withdrawal requests
get
Get withdrawal request
get
Delete withdrawal request
del
Locked network fee
Get withdrawal quote
get
Execute withdrawal
post
UMA
Performs an UMA lookup prior to initiating a withdrawal
get
Request UMA Withdrawal
post
Query withdrawals
Get withdrawal addresses
get
Get withdrawal address
get
Get fiat accounts
get
Get fiat account
get
Get network fee estimate
get
Validate address
get
Transfers
Get transfers
get
Create transfer
post
Get transfer
get
Movements
List movements
get
Participants
Individual Participants
Create customer
post
Submit documents
post
Update customer
patch
Lock customer
post
Create beneficiary
post
Update beneficiary
patch
Entity Participants
Create entity customer
post
Update entity customer
patch
Update entity user
patch
Submit entity documents
post
Get participant user basic info
get
Get participant user sanction screening info
get
Get participant user full info
get
Participant Jurisdictions
Evaluate participant onboarding
post
List countries
get
List subdivisions
get
Query Participants
List participants
get
Get participant
get
Get participant limits
get
Get participant KYC status
get
Get participant basic info
get
Get participant sanction screening info
get
Get participant full info
get
TRANSACT
Payments
External Account
Close external account
post
List external accounts
get
Create external accounts
post
Generate Payment
Create payment
post
Get quote
post
Execute quote
post
Retry a Fiat payment
post
Query Payments
List payments
get
Get payment by id
get
Get pending Fiat transactions
get
List Fiat transactions
get
List Fiat transaction statuses
get
Convert and Withdraw
Get quote
post
Execute quote
post
Fund
Request Quote
Get quote
post
List transactions
get
Deposits
Create deposit
post
Create withdrawal
post
Get withdrawal
get
TRADING
Positions
List positions
get
List platform positions
get
Index
List index prices
get
Market Data
List symbol data
get
List OHLCV data
get
List news articles
get
List news feeds
get
List categories
get
Trades
Submit trade
post
Get trades
get
Submit batch of trades
post
Get trade
get
Liquidity
Get quote
post
Update quote
patch
Execute quote
post
CLOB
Accounts
Create account (CLOB)
post
List accounts (CLOB)
get
Update CLOB account
patch
Get account balance
post
List account balances
post
Order Management
Submit order
post
Cancel order
post
List open orders
post
Create order subscription
post
Get order executions
post
List orders
post
Market Data
Market data subscription
post
Get trade stats
post
List instruments
post
Rewards
Disperse rewards
post
Awards
Fund awards account
post
Distribute awards
post
Staking
Create a new stake
post
Unstake assets
post
Get stake status
get
List participant stakes
get
List staking rewards
get
SDK
Overview
Installation
Getting Started
Modules
User Onboarding
Acquire an onboarding access token
Verification results
Iframe integration - Permissions
Crypto Buy
Profile
Crypto Sell
Crypto Withdrawals
Fiat Deposits
Fiat Withdrawals
Fund
Fiat Account Link
Crypto Account Link
SDK Authorization
Generate a client access token
post
Revoke a client access token
post
Integration with Mobile Apps
Flutter
Kotlin
React Native
Swift
SDK Mappers
Webhooks
Overview
Webhook Security
Participants
Participant status updates
Participant onboarding status update
Payments
Payments status updates
External account status updates
Account Funding
Fund Transaction Updates
Assets
Asset price change updates
Accounts
Account Balance update
Customer Account status update
Trades
Trade Status update
websockets
Private Websocket API
Authentication
Balance Subscription
Initial Subscription
Balance Updates
Subscription Filters
Price Subscription
List Symbols
Subscribing to a Symbol
Price Updates
Maintaining Subscription
FIX API
Central Limit Order Book
Session Level Messages
Standard Headers
Standard Trailers
Login (35=A)
Logout (35=5)
Heartbeat (35=0)
Reject (35=3)
FIX Order Entry
New Order Single (35=D)
Order Cancel Request (35=F)
Cancel Replace (35=G)
Order Cancel Reject (35=9)
Execution Report (35=8)
Business Message Reject (35=j)
FIX Market Data
Securities Request List (35=x)
Security List (35 = y)
Market Data Request (35=V)
Market Data Snapshot (W)
Market Data Incremental Refresh (35=X)
Drop Copy Message
Execution Report (35=8)
Appendix
Instrument
Order Quantity
Parties
MDFullGrp
FIX 5.0 XML Files - Order Gateway
FIX 5.0 XML Files - Market Data Gateway
FIX Rejects Reasons
Straight Through Processing
Connect
/oauth/token
Generate access token
post
/api/v1/sessions
Initialize session
post
Powered by
Balance Subscription
Ask AI