private/otc/request-deal (RFQ)

POST 
/private/otc/request-deal

Request a deal from a quote (RFQ flow).

Request

Body

required

id int64required

Request id (echoed in response)

method stringrequired

Must be "private/otc/request-deal"

api_key stringrequired

Your API key (only required for private REST)

sig stringrequired

HMAC-SHA256 signature in hex (only required for private REST)

nonce int64required

Current timestamp in milliseconds, e.g. "1771761038000".

params objectrequired
deal_type stringrequired
Possible values: [QUOTE_REQUEST]
Should be QUOTE_REQUEST
cl_deal_id stringrequired
Client provided ID for the deal. Should be unique per deal request. Accepted characters a-z, A-Z, 0-9, _, -
quote_id stringrequired
quote_id obtained from user.otc_qr.quotes
quote_req_id stringrequired
quote_req_id obtained from user.otc_qr.requests
leg_list object[]required
List of legs for the deal request.
Array [
instrument_name stringrequired
Instrument symbol (e.g., BTC_USD). Same value used in request-quote.
price decimalrequired
Bid or ask obtained from user.otc_qr.quotes.
quantity decimal
Client either provide quantity or notional. Same value used in request-quote.
notional decimal
Client either provide quantity or notional. Same value used in request-quote.
side stringrequired
Possible values: [BUY, SELL]
BUY or SELL
]

Success.

Schema

id int64

Echoed request id

method string

Method invoked

code int32

0 = success; non-zero indicates error (reason code).

result object
Present when code === 0.
deal_id string
System generated unique ID for the deal
cl_deal_id string
Client provided ID for the deal request
quote_id string
System generated unique ID for the quote
quote_req_id string
System generated unique ID for the quote request
deal_type string
Deal type
deal_status string
Possible values: [ACCEPTED, REJECTED]
ACCEPTED = system received deal; REJECTED = deal rejected
reason string
e.g. NO_ERROR
update_time_ns string
Unix epoch time when deal last updated in nanosecond
leg_list object[]
List of legs for the deal.
Array [
instrument_name string
Instrument symbol (e.g., BTC_USD)
price decimal
Echoed back from quote
quantity decimal
Echoed back from quote request if requested quantity
notional decimal
Echoed back from quote request if requested notional
executed_quantity decimal
Executed quantity
executed_notional decimal
Executed notional
side string
Possible values: [BUY, SELL]
Echoed back from deal
type string
Possible values: [PRICE]
e.g. PRICE
]
message string

Present when code !== 0.

original string

Present when code !== 0.