API Reference
Portal

Submit trade

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

Submits a trade for settlement that was matched and executed outside of zerohash.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Body Params

Trade details including counterparties, settlement schedule, amounts, and prices for external execution settlement.

string | null

A unique identifier for a batch of trades. Null when the trade was not submitted as part of a batch.

string
required
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

string
required
length ≤ 50

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

string
length ≤ 50

A code to identify the person or entity submitting the trade

string | null

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. Null when not supplied at trade submission.

string | null

Instructs zerohash to settle trades according to a certain schedule. Null when not supplied at trade submission.

string
required
length between 6 and 6

The unique identifier to the Platform on which the trade was executed, as provided by zerohash.

string | null

The ISO 10383 market identifier code for the platform. Null when not supplied at trade submission.

string
required
length ≤ 25

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

string
enum
required

spot or forward

Allowed:
string
enum
required

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

Allowed:
string
required

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.

string

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

string
enum

The current state of the trade;

  • accepted : The trade has been booked by zerohash and pending settlement in the next settlement cycle between the platform and zerohash.
  • active : The trades are eligible for settlement and there are pending payable and receivable obligations.
  • terminated : The trade has been terminated by settlement.
Allowed:
boolean
required

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

number
required
1254408627334 to 2554408627334

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

number
1254408627334 to 2554408627334

The unix timestamp at which the trade was accepted by zerohash and entered into an accepted status.

number | null
1254408627334 to 2554408627334

The unix timestamp in milliseconds at which the trade was defaulted. Null when the trade has not defaulted.

number | null
1254408627334 to 2554408627334

The unix timestamp in milliseconds at which the trade entered a settled state. Trades are generally settled instantaneously. Null until the trade is settled.

string | null

Some comments about the trade for zerohash to store. Null when not supplied at trade submission.

number
1254408627334 to 2554408627334

The unix timestamp of the last update to the trade object.

boolean
required

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.

string | null

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

number

The contract size

string
enum

the underlying asset

string
enum

the quoted asset

Allowed:
number | null
1254408627334 to 2554408627334

The unix timestamp in milliseconds when final settlement will first be attempted - if not included, the standard platform settlement instructions will be applied. Null when not supplied at trade submission.

number | null
1254408627334 to 2554408627334

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

string | null

An optional field that clients can use to specify the fee taken by the banking partner (supports 2 decimal places). Null when not supplied at trade submission.

string | null

The spread_notional is a field that shows the notional cost of the spread applied to the trade. This field is relevant for trades that are executed using the zerohash RFQ system. Returns null when no spread applied.

string | null

The spread_bps is a field that shows the spread in basis points that was applied to the trade. This field is relevant for trades that are executed using the zerohash RFQ system. Returns null when no spread applied.

string | null

The rate (in basis points) of the issuer fee applied to the trade. Returns null when no issuer fee applied.

string | null

The notional amount of the issuer fee applied to the trade, denominated in the quoted_currency. Returns null when no issuer fee applied.

string | null
enum

The type of payor that paid the issuer fee. Returns null when no issuer fee applied.

Allowed:
string | null
enum

Specifies the method through which the movement was initiated, indicating whether it originated via our REST API, SDK, or Secondary Portal. Returns null for legacy/externally-reported trades.

Allowed:
parties
array of objects
required
length between 2 and 2
parties*
string
enum
required

The side of the trade for the participant - buy or sell

Allowed:
string
required
length between 6 and 6

The participant_code of the trade party.

string
required
length ≤ 25

The asset being traded by the party.

string
required
length ≤ 30

The amount of the asset being traded by the party.

string | null
enum

Indicates whether the party added or removed liquidity from the market. This field is relevant for orders that were executed on the zerohash CLOB.

Allowed:
string | null

A unique ID for the trade, preferably a UUID.

string | null

The unique identifier of the order generated on the zerohash CLOB.

number | null
1254408627334 to 2554408627334

The unix timestamp in milliseconds when the party entered an obligations_outstanding settlement state. Null when the party has not yet entered this state.

number | null
1254408627334 to 2554408627334

The unix timestamp in milliseconds when the party met its current obligations. Null when obligations have not yet been met.

string | null
enum

The current settlement state for this party. Null when the trade is in accepted state and settlement has not yet been attempted.

Allowed:
string | null

The unique identifier for the execution of the trade. Null when the trade was not executed on the zerohash CLOB.

boolean

Indicates whether this party is responsible for settling its side of the trade at zerohash.

string | null
Defaults to general

The account_label that the party executed the trade on, if applicable. This field is relevant for platforms integrated using custom account_label for the zerohash participants. If not provided, the trade will be associated with the default (general) account for the participant.

string | null

The percentage of collateral required for the trade. Null when collateralization does not apply.

string | null

The account profile associated with the executing account (e.g. nonprefunded). Null when the party is not tied to a profiled account.

string | null

Participant who placed the order on the trading zerohash trading venue. This field is relevant for orders that were executed on the zerohash CLOB using the Multi Tenant Accounts. Null when not applicable.

string | null

The urn associated with the account that executed the trade, if applicable. This field is relevant for platforms integrated with the zerohash Multi Tenant Accounts. Returns null when the trade was not executed by a multi-tenant account.

string | null
enum

Indicates if the order was submitted manually via a user interface or via an API / Automated solution. Null when not applicable.

Allowed:
string
enum
required

The side of the trade for the participant - buy or sell

Allowed:
string
required
length between 6 and 6

The participant_code of the trade party.

string
required
length ≤ 25

The asset being traded by the party.

string
required
length ≤ 30

The amount of the asset being traded by the party.

string | null
enum

Indicates whether the party added or removed liquidity from the market. This field is relevant for orders that were executed on the zerohash CLOB.

Allowed:
string | null

A unique ID for the trade, preferably a UUID.

string | null

The unique identifier of the order generated on the zerohash CLOB.

number | null
1254408627334 to 2554408627334

The unix timestamp in milliseconds when the party entered an obligations_outstanding settlement state. Null when the party has not yet entered this state.

number | null
1254408627334 to 2554408627334

The unix timestamp in milliseconds when the party met its current obligations. Null when obligations have not yet been met.

string | null
enum

The current settlement state for this party. Null when the trade is in accepted state and settlement has not yet been attempted.

Allowed:
string | null

The unique identifier for the execution of the trade. Null when the trade was not executed on the zerohash CLOB.

boolean

Indicates whether this party is responsible for settling its side of the trade at zerohash.

string | null
Defaults to general

The account_label that the party executed the trade on, if applicable. This field is relevant for platforms integrated using custom account_label for the zerohash participants. If not provided, the trade will be associated with the default (general) account for the participant.

string | null

The percentage of collateral required for the trade. Null when collateralization does not apply.

string | null

The account profile associated with the executing account (e.g. nonprefunded). Null when the party is not tied to a profiled account.

string | null

Participant who placed the order on the trading zerohash trading venue. This field is relevant for orders that were executed on the zerohash CLOB using the Multi Tenant Accounts. Null when not applicable.

string | null

The urn associated with the account that executed the trade, if applicable. This field is relevant for platforms integrated with the zerohash Multi Tenant Accounts. Returns null when the trade was not executed by a multi-tenant account.

string | null
enum

Indicates if the order was submitted manually via a user interface or via an API / Automated solution. Null when not applicable.

Allowed:
string
length ≤ 50

A session identifier to group filled orders that were executed in the same trading session on the zerohash CLOB. An empty string is returned when the trade was not executed on the zerohash CLOB.

payment_processor
object | null

Identifier for the payment service processor that funded the trade, when applicable. Null when the trade was not funded via a payment processor.

fees
array of objects
fees
Headers
string
required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

string
required

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Responses

Updated 26 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 26 days ago