Order API

Get order's book

Request

• method: POST

• url: /volare/vTokens/{contract}/orders/book

• path:

Name	Type	Description	Example
contract	string	The vToken address.	0xc4129a3d3f495442f3e58e914352eebb84df68c2

• query:

Name	Type	Description	Example
side	number	This is a ask order when 1, or is a bid order when 2.	1

Response

Data Type

Name	Type	Description
price	string	The price of an option.
size	string	The number of unfilled options.

Example

[
  {
    "price": "25000000",
    "size": "200000000"
  }
]

Get filled orders

Request

• method: POST

• url: /volare/vTokens/{contract}/orders/filled

• path:

Name	Type	Description	Example
contract	string	The vToken address.	0xc4129a3d3f495442f3e58e914352eebb84df68c2

Response

Data Type

Name	Type	Description
timestamp	number	The timestamp at which the event is emitted.
price	string	The price of an option.
size	string	The number of filled options.

Example

[
  {
    "timestamp": 1655371014,
    "price": "25000000",
    "size": "124000000"
  }
]

Get limit orders

Request

• method: POST

• url: /volare/vTokens/{contract}/orders/limits

• path:

Name	Type	Description	Example
contract	string	The vToken address.	0xc4129a3d3f495442f3e58e914352eebb84df68c2

• query:

Name	Type	Description	Example
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1

Response

Data Type

Name	Type	Description
orderHash	string	The order hash.
side	number	This is a ask order when 1, or is a bid order when 2.
type	number	This is a limit order when 1, or is a market order when 2.
price	string	The price of an option.
amount	string	The number of options.
filled	string	The number of filled options.
size	string	The number of unfilled options.
fee	string	The transaction fees.
expiry	number	The timestamp when this order expired.
ctime	number	The created timestamp.

Example

[
  {
    "orderHash": "0xdf9db3bb1380f3e58d36511b2384d475a1509bbca829eb25f45beff0c18bd308",
    "side": 1,
    "type": 1,
    "price": "50000000",
    "amount": "76000000",
    "filled": "0",
    "size": "76000000",
    "fee": "0",
    "expiry": 1655446336,
    "ctime": 1655359937
  }
]

Get orders history

Request

• method: POST

• url: /volare/vTokens/{contract]/orders/limits/history

• path:

Name	Type	Description	Example
contract	string	The vToken address.	0xc4129a3d3f495442f3e58e914352eebb84df68c2

• query:

Name	Type	Description	Example
address	string	The owner address.	0xd894cf83f2f8d1d795b4c0ddc7f86e2baedef3b1

Response

Data Type

Name	Type	Description
side	number	This is a ask order when 1, or is a bid order when 2.
type	number	This is a limit order when 1, or is a market order when 2.
price	string	The price of an option.
amount	string	The number of options.
filled	string	The number of filled options.
fee	string	The transaction fees.
expiry	number	The timestamp when this order expired.
ctime	number	The created timestamp.
mtime	number	The updated timestamp.
state	number	The order state.

Example

[
  {
    "side": 2,
    "type": 1,
    "price": "46000000",
    "amount": "62000000",
    "filled": "62000000",
    "fee": "0",
    "expiry": 1655305141,
    "ctime": 1655283542,
    "mtime": 1655283552,
    "state": 2
  }
]

Get a limit order

Request

• method: POST

• url: /volare/vTokens/{contract}/orders/limits/{hash}

• path:

Name	Type	Description	Example
contract	string	The vToken address.	0xc4129a3d3f495442f3e58e914352eebb84df68c2
hash	string	The order hash.	0xb9843e5947a9e2b066f7e0952aa55ada66aefef65cb2181848cc3f8605d4bf4a

Response

Data Type

Order

Example

{
  "vTokenAddress": "0xc4129a3d3f495442f3e58e914352eebb84df68c2",
  "orderHash": "0xb9843e5947a9e2b066f7e0952aa55ada66aefef65cb2181848cc3f8605d4bf4a",
  "side": 1,
  "type": 1,
  "price": "49000000",
  "priceScaled": 49,
  "amount": "40000000",
  "filled": "0",
  "size": "40000000",
  "fee": "0",
  "expiry": 1655380336,
  "ctime": 1655358737,
  "mtime": 1655358737,
  "limitOrder": {
    "makerToken": "0xc4129a3d3f495442f3e58e914352eebb84df68c2",
    "takerToken": "0x1ad483798422423e3471d2fa8a7ef6eb83bd4926",
    "makerAmount": "40000000",
    "takerAmount": "19600000",
    "maker": "0x5b3988233ecaaa9a8997d16476169490a0e450ad",
    "taker": "0x0000000000000000000000000000000000000000",
    "chainId": 43113,
    "verifyingContract": "0xc325452c274aa4b298e1cb028c1636bc9b5db639",
    "takerTokenFeeAmount": "0",
    "sender": "0x0000000000000000000000000000000000000000",
    "feeRecipient": "0x0000000000000000000000000000000000000000",
    "pool": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "salt": "1655358737313",
    "expiry": "1655380336"
  },
  "signature": {
    "v": 27,
    "r": "0x70451409e70f592c150dbfb1f376f374ce2ac70acf8ae3f6553f7fa256460a95",
    "s": "0x7055f0d4204864a4d33be250c9fa6fcc7d2a965c21b9dc071113f6b164502e4b",
    "signatureType": 2
  }
}

Put limit order

Request

• method: POST

• url: /volare/vTokens/{contract}/orders/limits/put

• path:

Name	Type	Description	Example
contract	string	The vToken address.	0xc4129a3d3f495442f3e58e914352eebb84df68c2

• body:

Data Type

Name	Type	Description
orderHash	string	The order hash.
limitOrder	LimitOrder	The limit order detail.
signature	Signature	The order signature.

Example

{
  "orderHash": "0xb9843e5947a9e2b066f7e0952aa55ada66aefef65cb2181848cc3f8605d4bf4a",
  "limitOrder": {
    "makerToken": "0xc4129a3d3f495442f3e58e914352eebb84df68c2",
    "takerToken": "0x1ad483798422423e3471d2fa8a7ef6eb83bd4926",
    "makerAmount": "40000000",
    "takerAmount": "19600000",
    "maker": "0x5b3988233ecaaa9a8997d16476169490a0e450ad",
    "taker": "0x0000000000000000000000000000000000000000",
    "chainId": 43113,
    "verifyingContract": "0xc325452c274aa4b298e1cb028c1636bc9b5db639",
    "takerTokenFeeAmount": "0",
    "sender": "0x0000000000000000000000000000000000000000",
    "feeRecipient": "0x0000000000000000000000000000000000000000",
    "pool": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "salt": "1655358737313",
    "expiry": "1655380336"
  },
  "signature": {
    "v": 27,
    "r": "0x70451409e70f592c150dbfb1f376f374ce2ac70acf8ae3f6553f7fa256460a95",
    "s": "0x7055f0d4204864a4d33be250c9fa6fcc7d2a965c21b9dc071113f6b164502e4b",
    "signatureType": 2
  }
}

Response

Example

"OK"