Helpdesk
  • Overview
    • Welcome to Finery Markets
    • About Our Products
      • FM Liquidity Match
        • Master Account
        • Sub-Account
      • FM Pulse
      • White Label solution
  • Product Features
    • Onboarding
    • Risk Management
    • Trading
      • Aggregated Order Book
      • Firm Order Book
      • Pending Limit Orders (GTC)
      • Quote streams
      • RFQ
      • Toxic Flow Protection
      • Markups
      • Authorized trading
      • Non-Deliverable Trading
      • Voice Trading
      • Interdealer Trading
    • Position Management
    • Settlements
      • Automated Settlements
      • Addresses
    • Control Center
      • Multi-Roles
      • Notifications
      • Reporting
      • Bulk Edit
    • Referral program
  • API Reference
    • Quick Start with API
      • For Market Makers
      • For Takers
    • Data Types
    • REST API
      • Client management
        • connectCounterparty
        • cancelConnectionInvite
        • getCounterpartyInfo
        • getSubaccounts
      • Trading
        • Order Book & QS
          • add
          • add (authorized)
          • Pending limit orders
            • add (pending limit order)
            • add (pending limit order) (authorized)
            • del
            • del (authorized)
            • delAll
            • delAll (authorized)
            • orders
            • orders (authorized)
          • mod
          • del
          • delAll
          • book
          • voiceTrade
          • liquidationTrade
          • dealHistory
          • dealHistory (authorized)
          • instruments
          • positions
          • instrumentMarkups
          • addInstrumentMarkups
          • delInstrumentMarkups
          • qs/getAvailableQsProviders
        • RFQ
          • getSettings
          • getSettings (authorized)
          • getUserSettings (authorized)
          • setUserSettings (authorized)
          • getProviders
          • getSessions
      • Settlements
        • settlementRequests
        • settlementOrders
        • settlementTransactions
        • settlementHistory
        • settlementTransactionHistory
        • addIncomingSettlementRequest
        • delIncomingSettlementRequest
        • delIncomingSettlementCPRequest
        • addOutgoingSettlementTransaction
        • addIncomingSettlementTransaction
        • sendSettlementTransaction
        • commitIncomingSettlementTransaction
        • delSettlementTransaction
      • Risk Management
        • climits
        • setCLimit
        • delCLimit
        • enableTrading
        • disableTrading
        • cAssetLimits
        • setCAssetLimit
        • delCAssetLimit
        • cShortSalesBan
        • setShortSalesBan
        • delShortSalesBan
        • enableInstrumentsWhitelist
        • setInstrumentsWhitelist
        • disableInstrumentsWhitelist
        • instrumentsWhitelist
      • Non-deliverable Trading
        • settings/getOvernightRates
        • settings/setOvernightRates
      • QS Stream Management
        • qs/addStream
        • qs/removeStream
        • qs/getStreams
        • qs/addTakerToStream
        • qs/delTakerFromStream
    • Websocket API
      • Feed 'A' - Assets
      • Feed 'P' - Positions
      • Feed 'L' - Counterparty limits
      • Feed 'B' - Global order books
      • Feed 'F' - Tradable order books
      • Feed 'R' - Settlement requests
      • Feed 'N' - Settlement transactions
      • Feed 'K' - Positions
      • Feed 'O' - Orders
      • Feed 'S' - Settlement orders
      • RFQ
      • QS for Liquidity Providers
        • Market Data
        • Trading
      • QS for Takers
        • Market Data
    • FIX API
      • Admin messages
      • Market Data
      • Trade
        • Trading for Takers
        • Trading for LPs and Masters
      • QS for Liquidity Providers
        • Market Data
        • Trading
      • QS for Takers
        • Market Data
    • Troubleshooting Errors
      • List of Error Codes
      • Error 3
      • Error 6
      • Error 7
      • Error 14
Powered by GitBook
On this page
  1. API Reference
  2. REST API
  3. Trading
  4. Order Book & QS

add

Places an order. Taker can specify order volume instead of order size.

POST /add

{
    "instrument": "BTC-USD",
    "clientOrderId": 123456789,
    "price": 999900000000,
    "size": 10000000,
    "side": "bid",
    "type": "limitIOC",
    "cod": false
}
{
    "id": 1245,
    "remainingSize": 8000000,
    "clientOrderId": 123456789,
    "cancelReason": 2,
    "deals": [
        {
            "counterpartyId": 42,
            "id": 23,
            "price": 999900000000,
            "size": 2000000,
            "volume": 19998000000,
            "delta": 0
        }
    ]
}
{
    "error": 2
}

Market Makers can place a maximum of 30 orders on a single side of the order book.

Request parameters

Field name
Type
Description

instrument

string

Instrument name

clientOrderId

Efx::ClientOrderId

User data attached to the order

price

Efx::Price

Order limit price (for postOnly and limit orders)

size

Efx::Size

Order size. If specified - volume shouldn't be used

volume

Efx::Size

Order volume to be filled. Can be used by takers only. If specified - size shouldn't be used. By volume orders may be executed only in the Firm Book. Enabling QS will result into rejected order.

side

string

Order side, use "bid" to buy and "ask" to sell

type

string

Order types "limitIOC", "limitFOK", "marketIOC", "marketFOK" can only be used by market takers. "postOnly" and "limit" can only be used by market makers.

cod

boolean

Cancel On Disconnect flag (will be used only within Web Socket authenticated connection)

qsEnabled

boolean

If true, adds QS as potential sources of liquidity for the order execution. If false or omitted, only Firm Book is considered. Can only be used by takers.

firmBookEnabled

boolean

If true adds Firm Book as a potential source of liquidity for the order execution. If false, only QS are considered. False by default. Taken into account only if qsEnabled == true. Can only be used by takers.

makers

Array of Efx::ClientId

List of LPs to consider QS from. If empty or omitted, all available LPs considered. Taken into account only if qsEnabled == true and does not affect the Firm Book execution. Can only be used by takers.

Response description

Filed name
Type
Description

id

Efx::OrderId

New Order Id

clientOrderId

Efx::ClientOrderId

Optional user data attached to the order

remainingSize

Efx::Size

Remaining Order size after aggressive deals (if order was placed by size)

remainingVolume

Efx::Size

Remaining Order size after aggressive deals (if order was placed by volume)

cancelReason

unsigned int16

Cancel Reason:

0 - the order is filled (for Takers)

1 - by client (for Market Makers)

2 - the order has been partially filled (for Takers)

3 - by self-trade prevention (not in use)

4- on disconnect (for Market Makers) If "cancelReason" field is missing in response, it means that its value equals to 0.

deals

array of objects

Initial (taker) deals

Deal

id

Efx::DealId

Deal Id

price

Efx::Price

Deal price

size

Efx::Size

Deal size

volume

Efx::Size

Deal volume

delta

Efx::Size

Deal delta in quote (balance) currency

counterpartyId

unsigned int64

Counterparty id

counterpartySubaccountId

Efx::ClientId

Сounterparty Subaccount Id

liquiditySource

Efx::LiquiditySource

Liquidity source for the deal (optional). Defaults to the firm book if absent.

PreviousOrder Book & QSNextadd (authorized)

Last updated 10 days ago