Orders

Listing and creating your own order / trade.

get
Get Orders

https://api.vaultoro.com/v1/private/orders
This endpoint allows you to retrieve orders. To fetch your own orders, just pass self=true with the request.
Request
Response
Request
Headers
VTOKEN
required
string
Your API token to authenticate requests.
Query Parameters
queued
optional
string
Sets the status filter to OPEN and QUEUED.
status
optional
string
The status of the order. This can be OPEN, CLOSED, FILLED, CANCELLED, or QUEUED for the private endpoint.
since
optional
string
Unix timestamp to filter results until.
until
optional
string
Unix timestamp to filter results until.
self
optional
boolean
Return a list of your own orders. Must be set to true.
sortDirection
optional
number
The direction of the sorting. Either 1 or -1.
sort
optional
string
Sort the results by createdAt or updatedAt
matchType
optional
string
Filter the type of order. Currently only LIMIT.
pair
required
string
Filter by available pairs.
status
optional
string
The status of the order. Should be OPEN, CLOSED, FILLED, CANCELLED.
type
optional
string
The type of order. Should be BUY or SELL.
limit
optional
string
Limit the number of results.
page
optional
number
Return a specific page.
Response
200: OK
Cake successfully retrieved.
{
"data": [
{
"createdAt": 1595357594,
"initialQuantity": 12,
"matchType": "LIMIT",
"pair": "GOLDBTC",
"quantity": "0.0000",
"status": "FILLED",
"type": "SELL",
"updatedAt": 1595357766,
"value": "0.00615450"
},
{
"createdAt": 1595357730,
"initialQuantity": 12,
"matchType": "LIMIT",
"pair": "GOLDBTC",
"quantity": "0.0000",
"status": "FILLED",
"type": "SELL",
"updatedAt": 1595358200,
"value": "0.00615450"
}
]
}
404: Not Found
Could not find a cake matching this query.
{
"data": []
}

post
Create Order

https://api.vaultoro.com/v1/private/orders
The endpoint allows you to create an order. After creation, your order will be placed in a queue and further checks run. Only one order can be made at a time.
Request
Response
Request
Headers
wallet-origin
optional
string
Authentication
optional
string
Authentication token.
VTOKEN
optional
string
Use an API token to authorise the requests instead of the standard authentication token.
Body Parameters
price
required
number
The price of the order you wish to make.
type
required
string
The type of order, BUY or SELL.
quantity
required
number
The quantity you wish you purchase.
matchType
required
string
The match type, must be set to LIMIT or OTC right now.
pair
required
string
The pair you wish to trade.
Response
200: OK
{
"data": {
"result": {
"referenceId": "1nod461th2kpqzsr56",
"createdAt": 1623335089,
"matchType": "LIMIT",
"price": "0.2121",
"quantity": "0.5",
"type": "SELL"
}
}
}

delete
Cancel an order

https://api.vaultoro.com/v1/private/orders/{referenceId}
Cancel an order that's currently processing.
Request
Response
Request
Path Parameters
referenceId
required
string
The referenceId for the order that's returned on create
Headers
VTOKEN
required
string
Your API Token.
Response
200: OK
{"data":{"cancelled":true}}

get
Get an Order

https://api.vaultoro.com/v1/private/orders/{referenceId}
The endpoint allows you to retrieve a single order using the referenceId.
Request
Response
Request
Path Parameters
referenceId
required
string
The referenceId for the order that's returned on create
Headers
VTOKEN
required
string
Your API token.
Response
200: OK

post
Create Quote

https:api.vaultoro.com/v1/private/orders/quote
The endpoint allows you to create a quote.
Request
Response
Request
Headers
VTOKEN
required
string
Your API token.
Body Parameters
quantity
optional
string
The quantity for which you wish to create a quote.
total
optional
string
type
required
string
The type of order. Should be BUY or SELL.
pair
required
string
Filter by available pairs.
Response
200: OK