Submit batch of trades

post https://api.cert.zerohash.com/trades/batch

Submits a batch of trades for settlement that was matched and executed outside of Zero Hash.

Responses

Response body

array of objects

object

batch_trade_id

string

length ≤ 50

A unique identifier for a batch of trades

client_trade_id

string

length ≤ 50

A unique identifier for the trade, generally produced by the Platform on which the trade was executed. Note: this must be unique, per platform, per 72 hour period

trade_reporter

string

length ≤ 50

A text field to indicate the name or identifier of the person or entity submitting the trade, e.g. an email address

trade_reporter_code

string

length ≤ 50

A code to identify the person or entity submitting the trade

reporting_party

string

length between 6 and 6

The original reporter of the trade. This field is optional and must be a 6 digit participant code of which you have proper relationships with

settlement_schedule

string

length between 6 and 6

Instructs Zero Hash to settle trades according to a certain schedule

platform_code

string

length between 6 and 6

The unique identifier to the Platform on which the trade was executed, as provided by Zero Hash

market_identifier_code

string

length ≤ 50

The ISO 10383 market identifier code for the platform

symbol

string

length ≤ 25

A free text field to identify the pair being traded, e.g. BTC/USD

product_type

string

spot or forward

spot forward

trade_type

string

The type of trade to be settled. Valid values are regular or block

regular block

trade_price

string

The price the trade was executed
Note: if the amount is included per side, then this must equal to the seller's amount divided by the buyer's amount accurate for up to 20 figures.

trade_quantity

string

The quantity purchasedNote: if the amount is included per side, then this should not be included, otherwise it is required

trade_state

string

accepted active terminated

physical_delivery

boolean

A boolean statement to indicate if the trade is physically delivered. Currently Zero Hash only supports physically-settled trades, i.e. a value of true

transaction_timestamp

number

1254408627334 to 2554408627334

The unix timestamp the trade was executed on the external platform in milliseconds

accepted_timestamp

number

1254408627334 to 2554408627334

The unix timestamp at which the trade was accepted

defaulted_timestamp

number

1254408627334 to 2554408627334

The unix timestamp at which the trade was defaulted

settled_timestamp

number

1254408627334 to 2554408627334

The unix timestamp at which the trade was settled

comment

string

length ≤ 500

last_update

number

1254408627334 to 2554408627334

The unix timestamp of the last update

parties_anonymous

boolean

A boolean flag to determine if the counterparties are known to each other (false if the platform_code is also a counterparty) to the trade

settlement_price_index_id

string

length ≤ 20

The unique identifier of the benchmark settlement price to be used when calculating settlement obligations on trades that are settled at Zero Hash - required for forwards only

contract_size

number

The contract size

underlying

string

length ≤ 20

The underlying asset

quoted_currency

string

length ≤ 20

The quoted asset

settlement_timestamp

number

1254408627334 to 2554408627334

The datetime when final settlement will first be attempted - if not included, the standard platform settlement instructions will be applied

expiry_timestamp

number

1254408627334 to 2554408627334

The last datetime that the product can be traded, and the datetime that all final prices will be set, i.e. the fixing date - relevant for forwards onlyNote: after this point, there is no more ability to exit the trade or change its economics

bank_fee

string

An optional field that clients can use to specify the fee taken by the banking partner (supports 2 decimal places)

spread_notional

string

length ≤ 50

spread_notional is a field that shows the notional cost of the spread applied

spread_bps

string

length ≤ 50

spread_bps is a field that shows the spread (in BPS) being applied

origin

string

Specifies the method through which the movement was initiated, indicating whether it originated via our REST API, SDK, or Secondary Portal.

rest_api sdk secondary

parties

array of objects

length between 2 and 2

parties

object

side

string

required

buy sell

participant_code

string

required

length between 6 and 6

asset

string

required

length ≤ 25

amount

string

length ≤ 30

liquidity_indicator

string

added removed

client_order_id

string

length ≤ 36

A unique ID for the trade, preferably a UUID

order_id

string

length ≤ 100

obligations_outstanding_timestamp

number

1254408627334 to 2554408627334

The unix timestamp for outstanding obligations

current_obligations_met_timestamp

number

1254408627334 to 2554408627334

The unix timestamp for met current obligations

settlement_state

string

The current settlement state

null obligations_outstanding current_obligations_met settled defaulted counterparty_defaulted

execution_id

string

length ≤ 100

settling

boolean

account_label

string

length ≤ 20

The account label to allocate the trade

collateral_percentage

string

length ≤ 6

account_profile

string

session_id

string

length ≤ 50

A unique session id

payment_processor

object

fees

array of objects

fees

object

name

string

required

amount

string

required

trade_id

string

length ≤ 50

Zero Hash trade ID

network_fee_notional

string

length ≤ 50

notional value of the quoted network fee, denominated in the quoted_currency

network_fee_quantity

string

length ≤ 50

Raw quantity value of the quoted network fee, denominated in the network fee asset associated with the underlying asset

total_notional

string

length ≤ 50

Total notional value of the executed quote, denominated in the quoted_currency

asset_cost_notional

string

length ≤ 50

asset_cost_notional is a field that shows the notional cost of the asset

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.cert.zerohash.com/trades/batch \
3
     --header 'X-SCX-SIGNED: [WEB] auto-generated on fly' \
4
     --header 'X-SCX-TIMESTAMP: [WEB] auto-generated on fly' \
5
     --header 'accept: application/json' \
6
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable