> For the complete documentation index, see [llms.txt](https://faq.finerymarkets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://faq.finerymarkets.com/api-reference.md).

# API Reference

- [Quick Start with API](https://faq.finerymarkets.com/api-reference/quick-start-with-api.md)
- [For Market Makers](https://faq.finerymarkets.com/api-reference/quick-start-with-api/for-market-makers.md): If you intend to supply liquidity to the platform
- [For Takers](https://faq.finerymarkets.com/api-reference/quick-start-with-api/for-takers.md): If you intend to consume liquidity from Finery Markets
- [Data Types](https://faq.finerymarkets.com/api-reference/data-types.md)
- [REST API](https://faq.finerymarkets.com/api-reference/rest-api.md)
- [Client management](https://faq.finerymarkets.com/api-reference/rest-api/client-management.md)
- [connectCounterparty](https://faq.finerymarkets.com/api-reference/rest-api/client-management/connectcounterparty.md): Send or accept counterparty connection request
- [cancelConnectionInvite](https://faq.finerymarkets.com/api-reference/rest-api/client-management/cancelconnectioninvite.md): Cancel or reject an invitation to connect.
- [getCounterpartyInfo](https://faq.finerymarkets.com/api-reference/rest-api/client-management/getcounterpartyinfo.md): Returns information about one or all connected and invited counterparties.
- [getSubaccounts](https://faq.finerymarkets.com/api-reference/rest-api/client-management/getsubaccounts.md): Get sub-accounts list. For masters only
- [sendSubaccountInvite](https://faq.finerymarkets.com/api-reference/rest-api/client-management/sendsubaccountinvite.md): Add a new sub-account. For masters only
- [Trading](https://faq.finerymarkets.com/api-reference/rest-api/trading.md)
- [Adding orders](https://faq.finerymarkets.com/api-reference/rest-api/trading/adding-orders.md)
- [add](https://faq.finerymarkets.com/api-reference/rest-api/trading/adding-orders/add.md): Places an order. Taker can specify order volume instead of order size.
- [add (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/adding-orders/add-authorized.md): Places an order on behalf of a client. Only for masters
- [add algo (synthetic and GTC orders)](https://faq.finerymarkets.com/api-reference/rest-api/trading/adding-orders/add-algo-synthetic-and-gtc-orders.md): Places new order
- [add algo order (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/adding-orders/add-algo-order-authorized.md): Places new order on behalf of a client
- [voiceTrade](https://faq.finerymarkets.com/api-reference/rest-api/trading/adding-orders/voicetrade.md): Creates voice (manual) trade. Available only for makers.
- [liquidationTrade](https://faq.finerymarkets.com/api-reference/rest-api/trading/adding-orders/liquidationtrade.md): Creates trade to liquidate counterparty positions. Available only for makers.
- [Orders & Order Book](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book.md)
- [book](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/book.md): Returns a snapshot of the specified order book with max 25 levels on each side
- [Algo orders](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/algo-orders.md)
- [order](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/algo-orders/order.md): Retrieves existing order information
- [order (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/algo-orders/order-authorized.md): Retrieves existing order information on behalf of another client
- [orders](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/algo-orders/orders.md): Retrieves list of Algo orders
- [orders (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/algo-orders/orders-authorized.md): Retrieves list of Algo orders on behalf of another client
- [Pending limit orders](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders.md): This section outlines the REST API methods available for managing pending orders, including creating, deleting, and retrieving order details.
- [del](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders/del.md): Cancels a specific pending order
- [del (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders/del-authorized.md): Cancels a specific pending order
- [delAll](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders/delall.md): Cancels all pending orders for a specified instrument.
- [delAll (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders/delall-authorized.md): Cancels all pending orders for a specified instrument.
- [\[DEPRECATED\] add (pending limit order)](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders/deprecated-add-pending-limit-order.md): Places a pending limit order at a specified price. The taker can define either the order size or the volume
- [\[DEPRECATED\] add (pending limit order) (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders/deprecated-add-pending-limit-order-authorized.md): Places a pending limit order at a specified price. A master can define either the order size or the volume
- [\[DEPRECATED\] orders](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders/deprecated-orders.md): Retrieves details of pending limit orders
- [\[DEPRECATED\] orders (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/pending-limit-orders/deprecated-orders-authorized.md): Retrieves details of pending limit orders
- [mod](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/mod.md): Replaces an order
- [del](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/del.md): Cancels an order
- [delAll](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/delall.md): Cancels all client orders or all client orders for instrument if specified
- [getAvailableQsProviders](https://faq.finerymarkets.com/api-reference/rest-api/trading/orders-and-order-book/getavailableqsproviders.md): Returns the list of available providers to take from
- [RFQ](https://faq.finerymarkets.com/api-reference/rest-api/trading/rfq.md)
- [getSettings](https://faq.finerymarkets.com/api-reference/rest-api/trading/rfq/getsettings.md)
- [getSettings (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/rfq/getsettings-authorized.md)
- [getUserSettings (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/rfq/getusersettings-authorized.md): Get info about sub-account RFQ settings for user
- [setUserSettings (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/trading/rfq/setusersettings-authorized.md): Set info about sub-account RFQ settings for user
- [getProviders](https://faq.finerymarkets.com/api-reference/rest-api/trading/rfq/getproviders.md)
- [getSessions](https://faq.finerymarkets.com/api-reference/rest-api/trading/rfq/getsessions.md)
- [Deals & Positions](https://faq.finerymarkets.com/api-reference/rest-api/deals-and-positions.md)
- [positions](https://faq.finerymarkets.com/api-reference/rest-api/deals-and-positions/positions.md): Returns next deal id, positions, orders and settlement orders snapshot
- [dealHistory](https://faq.finerymarkets.com/api-reference/rest-api/deals-and-positions/dealhistory.md): Returns deal history.
- [dealHistory (authorized)](https://faq.finerymarkets.com/api-reference/rest-api/deals-and-positions/dealhistory-authorized.md): Returns deal history on behalf of a client. Only for masters
- [Risk Management](https://faq.finerymarkets.com/api-reference/rest-api/risk-management.md)
- [climits](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/climits.md): Returns Counterparty limits snapshot
- [setCLimit](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/setclimit.md): Sets or modifies a counterparty limit
- [delCLimit](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/delclimit.md): Deletes counterparty limit
- [enableTrading](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/enabletrading.md): Enables trading against counterparty. Enables both incoming and outgoing liquidity flows between two masters.
- [disableTrading](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/disabletrading.md): Disables trading against counterparty. Disables both incoming and outgoing liquidity flows between two masters.
- [enableIncomingLiquidity](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/enableincomingliquidity.md): For masters enables incoming liquidity from counterparty master.
- [disableIncomingLiquidity](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/disableincomingliquidity.md): For masters disables incoming liquidity from counterparty master.
- [enableOutgoingLiquidity](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/enableoutgoingliquidity.md): For masters enables outgoing liquidity to counterparty master.
- [disableOutgoingLiquidity](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/disableoutgoingliquidity.md): For masters disables outgoing liquidity to counterparty master.
- [cAssetLimits](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/cassetlimits.md): Returns Counterparty limits by asset snapshot
- [setCAssetLimit](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/setcassetlimit.md): Sets or modifies a counterparty asset limit
- [delCAssetLimit](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/delcassetlimit.md): Deletes counterparty asset limit
- [enableInstrumentsWhitelist](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/enableinstrumentswhitelist.md): Enables instruments whitelisting
- [setInstrumentsWhitelist](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/setinstrumentswhitelist.md): Sets global instruments whitelist. Only whitelisted instruments are allowed for trading.
- [disableInstrumentsWhitelist](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/disableinstrumentswhitelist.md): Disables instruments whitelist
- [instrumentsWhitelist](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/instrumentswhitelist.md): Returns whitelisted instruments
- [enableMarketData](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/enablemarketdata.md): Enables view-only market data for a counterparty
- [disableMarketData](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/disablemarketdata.md): Disables view-only market data for a counterparty.
- [marketDataViewers](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/marketdataviewers.md): Returns a list of counterparties authorized to see view-only marked data.
- [availableMarketDataProviders](https://faq.finerymarkets.com/api-reference/rest-api/risk-management/availablemarketdataproviders.md): Returns a list of counterparties who enabled market data or trading for the client.
- [Pricing & Instruments](https://faq.finerymarkets.com/api-reference/rest-api/pricing-and-instruments.md)
- [instruments](https://faq.finerymarkets.com/api-reference/rest-api/pricing-and-instruments/instruments.md): Returns currencies and instruments available
- [instrumentMarkups](https://faq.finerymarkets.com/api-reference/rest-api/pricing-and-instruments/instrumentmarkups.md): Returns a list of instrument markups.
- [addInstrumentMarkups](https://faq.finerymarkets.com/api-reference/rest-api/pricing-and-instruments/addinstrumentmarkups.md): Sets markups for instruments per counterparty. Reserved for market makers and masters only.
- [delInstrumentMarkups](https://faq.finerymarkets.com/api-reference/rest-api/pricing-and-instruments/delinstrumentmarkups.md): Removes markups for instrument for counterparty. For makers and masters only.
- [Synthetic Instruments](https://faq.finerymarkets.com/api-reference/rest-api/pricing-and-instruments/synthetic-instruments.md)
- [/synthetic/addInstrument](https://faq.finerymarkets.com/api-reference/rest-api/pricing-and-instruments/synthetic-instruments/synthetic-addinstrument.md): Add new Synthetic Instrument
- [/synthetic/instruments](https://faq.finerymarkets.com/api-reference/rest-api/pricing-and-instruments/synthetic-instruments/synthetic-instruments.md)
- [Settlements](https://faq.finerymarkets.com/api-reference/rest-api/settlements.md)
- [settlementRequests](https://faq.finerymarkets.com/api-reference/rest-api/settlements/settlementrequests.md): Returns requests for incoming and outgoing settlement
- [settlementOrders](https://faq.finerymarkets.com/api-reference/rest-api/settlements/settlementorders.md): Returns pending settlement orders
- [settlementTransactions](https://faq.finerymarkets.com/api-reference/rest-api/settlements/settlementtransactions.md): Returns incoming and outgoing settlement transactions
- [settlementHistory](https://faq.finerymarkets.com/api-reference/rest-api/settlements/settlementhistory.md): Returns settlement history
- [settlementTransactionHistory](https://faq.finerymarkets.com/api-reference/rest-api/settlements/settlementtransactionhistory.md): Returns settlement transaction history
- [addIncomingSettlementRequest](https://faq.finerymarkets.com/api-reference/rest-api/settlements/addincomingsettlementrequest.md): Adds a request for incoming settlement
- [delIncomingSettlementRequest](https://faq.finerymarkets.com/api-reference/rest-api/settlements/delincomingsettlementrequest.md): Removes a request for incoming settlement
- [delIncomingSettlementCPRequest](https://faq.finerymarkets.com/api-reference/rest-api/settlements/delincomingsettlementcprequest.md): Deprecated. delIncomingSettlementRequest should be used instead
- [addOutgoingSettlementTransaction](https://faq.finerymarkets.com/api-reference/rest-api/settlements/addoutgoingsettlementtransaction.md): Adds outgoing settlement transaction
- [addIncomingSettlementTransaction](https://faq.finerymarkets.com/api-reference/rest-api/settlements/addincomingsettlementtransaction.md): Adds incoming settlement transaction from sub-account to master
- [sendSettlementTransaction](https://faq.finerymarkets.com/api-reference/rest-api/settlements/sendsettlementtransaction.md): Indicates that settlement transaction has been sent
- [commitIncomingSettlementTransaction](https://faq.finerymarkets.com/api-reference/rest-api/settlements/commitincomingsettlementtransaction.md): Commits incoming settlement transaction
- [delSettlementTransaction](https://faq.finerymarkets.com/api-reference/rest-api/settlements/delsettlementtransaction.md): Deletes settlement transaction
- [Fireblocks](https://faq.finerymarkets.com/api-reference/rest-api/settlements/fireblocks.md): Fireblocks integration APIs
- [addOutgoingSettlementTransaction](https://faq.finerymarkets.com/api-reference/rest-api/settlements/fireblocks/addoutgoingsettlementtransaction.md): Adds an outgoing settlement transaction along with the creation of a new ticket on Fireblocks
- [delSettlementTransaction](https://faq.finerymarkets.com/api-reference/rest-api/settlements/fireblocks/delsettlementtransaction.md): Deletes a settlement transaction along with the cancellation of the matching ticket on Fireblocks
- [findTicket](https://faq.finerymarkets.com/api-reference/rest-api/settlements/fireblocks/findticket.md): Searches for a Fireblocks ticket by its Fireblocks Ticket ID or by the associated Settlement Transaction ID.
- [Non-deliverable Trading](https://faq.finerymarkets.com/api-reference/rest-api/non-deliverable-trading.md)
- [settings/getOvernightRates](https://faq.finerymarkets.com/api-reference/rest-api/non-deliverable-trading/settings-getovernightrates.md): Returns snapshot of overnight rates.
- [settings/setOvernightRates](https://faq.finerymarkets.com/api-reference/rest-api/non-deliverable-trading/settings-setovernightrates.md): Returns snapshot of overnight rates.
- [QS Stream Management](https://faq.finerymarkets.com/api-reference/rest-api/qs-stream-management.md)
- [qs/addStream](https://faq.finerymarkets.com/api-reference/rest-api/qs-stream-management/qs-addstream.md)
- [qs/removeStream](https://faq.finerymarkets.com/api-reference/rest-api/qs-stream-management/qs-removestream.md)
- [qs/getStreams](https://faq.finerymarkets.com/api-reference/rest-api/qs-stream-management/qs-getstreams.md)
- [qs/addTakerToStream](https://faq.finerymarkets.com/api-reference/rest-api/qs-stream-management/qs-addtakertostream.md)
- [qs/delTakerFromStream](https://faq.finerymarkets.com/api-reference/rest-api/qs-stream-management/qs-deltakerfromstream.md)
- [Websocket API](https://faq.finerymarkets.com/api-reference/websocket-api.md)
- [Feed 'A' - Assets](https://faq.finerymarkets.com/api-reference/websocket-api/feed-a-assets.md): Asset prices feed
- [Feed 'P' - Positions](https://faq.finerymarkets.com/api-reference/websocket-api/feed-p-positions.md): Positions, Orders and Settlement Orders feed
- [Feed 'L' - Counterparty limits](https://faq.finerymarkets.com/api-reference/websocket-api/feed-l-counterparty-limits.md): Counterparty limits feed
- [Feed 'B' - Global order book](https://faq.finerymarkets.com/api-reference/websocket-api/feed-b-global-order-book.md): Global book feed, returns only first 25 book levels
- [Feed 'F' - Firm Market Data](https://faq.finerymarkets.com/api-reference/websocket-api/feed-f-firm-market-data.md): Returns Tradable Order book or may return incremental updates of both Tradable Market Data or View-Only Market Data. Returns only the first 25 levels of the book
- [Feed 'MD' - View-only Firm Market data](https://faq.finerymarkets.com/api-reference/websocket-api/feed-md-view-only-firm-market-data.md): Feed 'MD' is a separate feed reserved for view-only Market Data from LPs. It is accessible by Taker and Master account types.
- [Feed 'R' - Settlement requests](https://faq.finerymarkets.com/api-reference/websocket-api/feed-r-settlement-requests.md): Settlement request feed
- [Feed 'N' - Settlement transactions](https://faq.finerymarkets.com/api-reference/websocket-api/feed-n-settlement-transactions.md): Settlement transaction feed
- [Feed 'K' - Positions](https://faq.finerymarkets.com/api-reference/websocket-api/feed-k-positions.md): Positions Feed
- [Feed 'O' - Orders](https://faq.finerymarkets.com/api-reference/websocket-api/feed-o-orders.md): Orders Feed
- [Feed 'D' - Deals](https://faq.finerymarkets.com/api-reference/websocket-api/feed-d-deals.md): Deals Feed
- [Feed 'S' - Settlement orders](https://faq.finerymarkets.com/api-reference/websocket-api/feed-s-settlement-orders.md): Settlement Orders Feed
- [RFQ](https://faq.finerymarkets.com/api-reference/websocket-api/rfq.md): RFQ trading API
- [QS for Liquidity Providers](https://faq.finerymarkets.com/api-reference/websocket-api/qs-for-liquidity-providers.md)
- [QS Market Data Feed](https://faq.finerymarkets.com/api-reference/websocket-api/qs-for-liquidity-providers/qs-market-data-feed.md)
- [QS Trading for Liquidity Providers](https://faq.finerymarkets.com/api-reference/websocket-api/qs-for-liquidity-providers/qs-trading-for-liquidity-providers.md)
- [QS for Takers](https://faq.finerymarkets.com/api-reference/websocket-api/qs-for-takers.md)
- [QS Market Data Feed](https://faq.finerymarkets.com/api-reference/websocket-api/qs-for-takers/qs-market-data-feed.md)
- [FIX API](https://faq.finerymarkets.com/api-reference/fix-api.md)
- [Admin messages](https://faq.finerymarkets.com/api-reference/fix-api/admin-messages.md)
- [Market Data](https://faq.finerymarkets.com/api-reference/fix-api/market-data.md)
- [Trade](https://faq.finerymarkets.com/api-reference/fix-api/trade.md): Start with this page to learn more about trading via FIX on Finery Markets
- [Trading for Takers](https://faq.finerymarkets.com/api-reference/fix-api/trade/trading-for-takers.md): This page describes the potential scenarios of submitting a taker order
- [Trading for LPs and Masters](https://faq.finerymarkets.com/api-reference/fix-api/trade/trading-for-lps-and-masters.md): This page describes the potential scenarios of submitting Maker orders
- [QS for Liquidity Providers](https://faq.finerymarkets.com/api-reference/fix-api/qs-for-liquidity-providers.md)
- [Market Data](https://faq.finerymarkets.com/api-reference/fix-api/qs-for-liquidity-providers/market-data.md)
- [Trading](https://faq.finerymarkets.com/api-reference/fix-api/qs-for-liquidity-providers/trading.md)
- [QS for Takers](https://faq.finerymarkets.com/api-reference/fix-api/qs-for-takers.md)
- [Market Data](https://faq.finerymarkets.com/api-reference/fix-api/qs-for-takers/market-data.md)
- [Troubleshooting Errors](https://faq.finerymarkets.com/api-reference/troubleshooting-errors.md)
- [List of Error Codes](https://faq.finerymarkets.com/api-reference/troubleshooting-errors/list-of-error-codes.md)
- [Error 3](https://faq.finerymarkets.com/api-reference/troubleshooting-errors/error-3.md): Not Authorised
- [Error 6](https://faq.finerymarkets.com/api-reference/troubleshooting-errors/error-6.md): Invalid Nonce
- [Error 7](https://faq.finerymarkets.com/api-reference/troubleshooting-errors/error-7.md): Invalid Timestamp
- [Error 14](https://faq.finerymarkets.com/api-reference/troubleshooting-errors/error-14.md): Invalid signature