PostOrderbookForm | OEX JS SDK

Types of PostOrderbookForm request

Index

Type aliases

RequestBody

RequestBody: { action: ORDER_ACTION; currency: string; expiresAt: number; price: number; quantity: number; ticker: string }

Type of PostOrderbookForm request body

Object representing requirement of client to obtain certain position in the market when and if it matches

Type declaration

action: ORDER_ACTION

Type of the Order action
currency: string

Address of ERC20 token used for premium to define Orderbook
expiresAt: number

Expiration of the Order in the Orderbook in UNIX timestamp

Set to 0 for GTC (Good Till Cancel) order i.e. order never expires
price: number

Price (premium) of the order per 1 contract
quantity: number

Quantity of contracts to buy / sell
ticker: string

Hash of the Ticker to define Orderbook

ResponseBody

ResponseBody: Array<{ id: string; orderToSign: { domain: { name: string; verifyingContract: string; version: string }; message: { affiliateAddress: string; affiliateFee: string; expiresAt: string; feeTokenAddress: string; makerAddress: string; makerMarginAddress: string; makerMarginAmount: string; makerTokenAmount: string; makerTokenId: string; nonce: string; relayerAddress: string; relayerFee: string; senderAddress: string; takerAddress: string; takerMarginAddress: string; takerMarginAmount: string; takerTokenAmount: string; takerTokenId: string }; primaryType: string; types: { EIP712Domain: Array<{ name: string; type: string }>; Order: Array<{ name: string; type: string }> } } }>

Type of PostOrderbookForm response body

Array of orders required to be signed in order to obtain requested position in the market when and if it matches

Signature of the orderToSign EIP712 message and id is required for finalization of position obtaining request