Expand description
API endpoints
Constantsยง
- ACCEPT_
BLOCK_ RFQ - Accept a Block RFQ quote (taker)
- ADD_
BLOCK_ RFQ_ QUOTE - Add a quote to a Block RFQ (maker)
- ADD_
TO_ ADDRESS_ BOOK - Add an address to the address book
- APPROVE_
BLOCK_ TRADE - Approve a pending block trade
- AUTH
- Public authentication endpoint
- BUY
- Place a buy order
- CANCEL
- Cancel a specific order
- CANCEL_
ALL - Cancel all orders
- CANCEL_
ALL_ BLOCK_ RFQ_ QUOTES - Cancel all Block RFQ quotes (maker)
- CANCEL_
ALL_ BY_ CURRENCY - Cancel all orders by currency
- CANCEL_
ALL_ BY_ CURRENCY_ PAIR - Cancel all orders by currency pair
- CANCEL_
ALL_ BY_ INSTRUMENT - Cancel all orders by instrument
- CANCEL_
ALL_ BY_ KIND_ OR_ TYPE - Cancel all orders by kind or type
- CANCEL_
BLOCK_ RFQ - Cancel a Block RFQ (taker)
- CANCEL_
BLOCK_ RFQ_ QUOTE - Cancel a single Block RFQ quote (maker)
- CANCEL_
BY_ LABEL - Cancel orders by label
- CANCEL_
QUOTES - Cancel quotes
- CANCEL_
TRANSFER_ BY_ ID - Cancel a transfer by ID
- CANCEL_
WITHDRAWAL - Cancel a pending withdrawal
- CHANGE_
API_ KEY_ NAME - Change API key name
- CHANGE_
MARGIN_ MODEL - Change margin model
- CHANGE_
SCOPE_ IN_ API_ KEY - Change API key scope
- CHANGE_
SUBACCOUNT_ NAME - Change the name of a subaccount
- CLOSE_
POSITION - Close an existing position
- CREATE_
API_ KEY - Create a new API key
- CREATE_
BLOCK_ RFQ - Create a new Block RFQ (taker)
- CREATE_
COMBO - Create or verify a combo book
- CREATE_
DEPOSIT_ ADDRESS - Create a new deposit address
- CREATE_
SUBACCOUNT - Create a new subaccount
- DELETE_
ADDRESS_ BENEFICIARY - Delete address beneficiary information
- DISABLE_
API_ KEY - Disable an API key
- EDIT
- Edit order
- EDIT_
API_ KEY - Edit an existing API key
- EDIT_
BLOCK_ RFQ_ QUOTE - Edit a Block RFQ quote (maker)
- EDIT_
BY_ LABEL - Edit order by label
- ENABLE_
AFFILIATE_ PROGRAM - Enable affiliate program
- ENABLE_
API_ KEY - Enable an API key
- EXECUTE_
BLOCK_ TRADE - Execute a block trade with counterparty signature
- GET_
ACCESS_ LOG - Get account access log
- GET_
ACCOUNT_ SUMMARIES - Get account summaries for all currencies
- GET_
ACCOUNT_ SUMMARY - Get account summary information
- GET_
ADDRESS_ BENEFICIARY - Get address beneficiary information
- GET_
ADDRESS_ BOOK - Get addresses from the address book
- GET_
AFFILIATE_ PROGRAM_ INFO - Get affiliate program information
- GET_
ANNOUNCEMENTS - Get public announcements
- GET_
APR_ HISTORY - Get APR history
- GET_
BLOCK_ RFQS - Get list of Block RFQs
- GET_
BLOCK_ RFQ_ QUOTES - Get open quotes for Block RFQs (maker)
- GET_
BLOCK_ RFQ_ TRADES - Get recent Block RFQ trades (public)
- GET_
BLOCK_ TRADE - Get a specific block trade by ID
- GET_
BLOCK_ TRADES - List block trades with optional filters
- GET_
BLOCK_ TRADE_ REQUESTS - Get pending block trade requests
- GET_
BOOK_ SUMMARY_ BY_ CURRENCY - Get book summary by currency
- GET_
BOOK_ SUMMARY_ BY_ INSTRUMENT - Get book summary by instrument
- GET_
BROKER_ TRADES - List broker trades
- GET_
BROKER_ TRADE_ REQUESTS - Get broker trade requests
- GET_
COMBOS - Get all active combos by currency
- GET_
COMBO_ DETAILS - Get combo details by ID
- GET_
COMBO_ IDS - Get list of combo IDs by currency and state
- GET_
CONTRACT_ SIZE - Get contract size for an instrument
- GET_
CURRENCIES - Get list of available currencies
- GET_
CURRENT_ DEPOSIT_ ADDRESS - Get the current deposit address
- GET_
DELIVERY_ PRICES - Get delivery prices
- GET_
DEPOSITS - Get deposits
- GET_
EMAIL_ LANGUAGE - Get email language preference
- GET_
EXPIRATIONS - Get expiration dates
- GET_
FUNDING_ CHART_ DATA - Get funding chart data
- GET_
FUNDING_ RATE_ HISTORY - Get funding rate history
- GET_
FUNDING_ RATE_ VALUE - Get current funding rate value
- GET_
HISTORICAL_ VOLATILITY - Get historical volatility data
- GET_
INDEX - Get index information
- GET_
INDEX_ CHART_ DATA - Get index chart data
- GET_
INDEX_ PRICE - Get index price
- GET_
INDEX_ PRICE_ NAMES - Get index price names
- GET_
INSTRUMENT - Get instrument information by name
- GET_
INSTRUMENTS - Get list of available instruments
- GET_
LAST_ SETTLEMENTS_ BY_ CURRENCY - Get last settlements by currency
- GET_
LAST_ SETTLEMENTS_ BY_ INSTRUMENT - Get last settlements by instrument
- GET_
LAST_ TRADES_ BY_ CURRENCY - Get last trades by currency
- GET_
LAST_ TRADES_ BY_ CURRENCY_ AND_ TIME - Get last trades by currency and time
- GET_
LAST_ TRADES_ BY_ INSTRUMENT - Get last trades by instrument
- GET_
LAST_ TRADES_ BY_ INSTRUMENT_ AND_ TIME - Get last trades by instrument and time
- GET_
LEG_ PRICES - Get individual leg prices for a combo structure
- GET_
MARGINS - Get margin requirements
- GET_
MARK_ PRICE_ HISTORY - Get mark price history
- GET_
MMP_ CONFIG - Get MMP configuration
- GET_
MMP_ STATUS - Get MMP status
- GET_
NEW_ ANNOUNCEMENTS - Get new (unread) announcements
- GET_
OPEN_ ORDERS - Get all open orders
- GET_
OPEN_ ORDERS_ BY_ CURRENCY - Get open orders by currency
- GET_
OPEN_ ORDERS_ BY_ INSTRUMENT - Get open orders by instrument
- GET_
OPEN_ ORDERS_ BY_ LABEL - Get open orders by label
- GET_
OPTIONS - Get options information
- GET_
OPTIONS_ PAIR - Get options pair information
- GET_
ORDER_ BOOK - Get order book for an instrument
- GET_
ORDER_ BOOK_ BY_ INSTRUMENT_ ID - Get order book by instrument ID
- GET_
ORDER_ HISTORY_ BY_ CURRENCY - Get order history by currency
- GET_
ORDER_ HISTORY_ BY_ INSTRUMENT - Get order history by instrument
- GET_
ORDER_ MARGIN_ BY_ IDS - Get order margin by IDs
- GET_
ORDER_ STATE - Get order state
- GET_
ORDER_ STATE_ BY_ LABEL - Get order state by label
- GET_
POSITION - Get position
- GET_
POSITIONS - Get current positions
- GET_
SERVER_ TIME - Get server time
- GET_
SETTLEMENT_ HISTORY_ BY_ CURRENCY - Get settlement history by currency
- GET_
SETTLEMENT_ HISTORY_ BY_ INSTRUMENT - Get settlement history by instrument
- GET_
STATUS - Get API status
- GET_
SUBACCOUNTS - Get subaccount information
- GET_
SUBACCOUNTS_ DETAILS - Get subaccounts details with positions
- GET_
SUPPORTED_ INDEX_ NAMES - Get supported index names
- GET_
TICKER - Get ticker information for an instrument
- GET_
TRADE_ VOLUMES - Get trade volumes
- GET_
TRADINGVIEW_ CHART_ DATA - Get TradingView chart data
- GET_
TRANSACTION_ LOG - Get transaction log
- GET_
TRANSFERS - Get transfers list
- GET_
TRIGGER_ ORDER_ HISTORY - Get trigger order history
- GET_
USER_ LOCKS - Get user account locks
- GET_
USER_ TRADES_ BY_ CURRENCY - Get user trades by currency
- GET_
USER_ TRADES_ BY_ CURRENCY_ AND_ TIME - Get user trades by currency and time
- GET_
USER_ TRADES_ BY_ INSTRUMENT - Get user trades by instrument
- GET_
USER_ TRADES_ BY_ INSTRUMENT_ AND_ TIME - Get user trades by instrument and time
- GET_
USER_ TRADES_ BY_ ORDER - Get user trades by order
- GET_
VOLATILITY_ INDEX_ DATA - Get volatility index data
- GET_
WITHDRAWALS - Get withdrawals
- INVALIDATE_
BLOCK_ TRADE_ SIGNATURE - Invalidate a block trade signature
- LIST_
ADDRESS_ BENEFICIARIES - List address beneficiaries with pagination
- LIST_
API_ KEYS - List all API keys
- LIST_
CUSTODY_ ACCOUNTS - List custody accounts
- MOVE_
POSITIONS - Move positions between subaccounts
- PME_
SIMULATE - PME margin simulation
- REJECT_
BLOCK_ TRADE - Reject a pending block trade
- REMOVE_
API_ KEY - Remove an API key
- REMOVE_
FROM_ ADDRESS_ BOOK - Remove an address from the address book
- REMOVE_
SUBACCOUNT - Remove an empty subaccount
- RESET_
API_ KEY - Reset an API key secret
- RESET_
MMP - Reset MMP limits
- SAVE_
ADDRESS_ BENEFICIARY - Save address beneficiary information
- SELL
- Place a sell order
- SET_
ANNOUNCEMENT_ AS_ READ - Mark announcement as read
- SET_
CLEARANCE_ ORIGINATOR - Set clearance originator for a deposit
- SET_
DISABLED_ TRADING_ PRODUCTS - Set disabled trading products
- SET_
EMAIL_ FOR_ SUBACCOUNT - Set email address for a subaccount
- SET_
EMAIL_ LANGUAGE - Set email language preference
- SET_
MMP_ CONFIG - Set MMP configuration
- SET_
SELF_ TRADING_ CONFIG - Set self-trading configuration
- SIMULATE_
BLOCK_ TRADE - Simulate if a block trade can be executed
- SIMULATE_
PORTFOLIO - Simulate portfolio margin
- SUBMIT_
TRANSFER_ BETWEEN_ SUBACCOUNTS - Submit transfer between subaccounts
- SUBMIT_
TRANSFER_ TO_ SUBACCOUNT - Submit transfer to subaccount
- SUBMIT_
TRANSFER_ TO_ USER - Submit transfer to user
- TEST_
CONNECTION - Test connection to the API
- TOGGLE_
NOTIFICATIONS_ FROM_ SUBACCOUNT - Enable or disable notifications for a subaccount
- TOGGLE_
SUBACCOUNT_ LOGIN - Enable or disable login for a subaccount
- UPDATE_
IN_ ADDRESS_ BOOK - Update an address in the address book
- VERIFY_
BLOCK_ TRADE - Verify and create a block trade signature
- WITHDRAW
- Create a new withdrawal request