Orders

Listing and creating your own order / trade.

Get Orders

GET 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.

Query Parameters

NameTypeDescription

queued

string

Sets the status filter to OPEN and QUEUED.

status

string

The status of the order. This can be OPEN, CLOSED, FILLED, CANCELLED, or QUEUED for the private endpoint.

since

string

Unix timestamp to filter results until.

until

string

Unix timestamp to filter results until.

self

boolean

Return a list of your own orders. Must be set to true.

sortDirection

number

The direction of the sorting. Either 1 or -1.

sort

string

Sort the results by createdAt or updatedAt

matchType

string

Filter the type of order. Currently only LIMIT.

pair

string

Filter by available pairs.

status

string

The status of the order. Should be OPEN, CLOSED, FILLED, CANCELLED.

type

string

The type of order. Should be BUY or SELL.

limit

string

Limit the number of results.

page

number

Return a specific page.

Headers

NameTypeDescription

VTOKEN

string

Your API token to authenticate requests.

{
    "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"
        }
    ]
}

Create Order

POST 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.

Headers

NameTypeDescription

wallet-origin

string

Authentication

string

Authentication token.

VTOKEN

string

Use an API token to authorise the requests instead of the standard authentication token.

Request Body

NameTypeDescription

price

number

The price of the order you wish to make.

type

string

The type of order, BUY or SELL.

quantity

number

The quantity you wish you purchase.

matchType

string

The match type, must be set to LIMIT or OTC right now.

pair

string

The pair you wish to trade.

{
    "data": {
        "result": {
            "referenceId": "1nod461th2kpqzsr56",
            "createdAt": 1623335089,
            "matchType": "LIMIT",
            "price": "0.2121",
            "quantity": "0.5",
            "type": "SELL"
        }
    }
}

Cancel an order

DELETE https://api.vaultoro.com/v1/private/orders/{referenceId}

Cancel an order that's currently processing.

Path Parameters

NameTypeDescription

referenceId

string

The referenceId for the order that's returned on create

Headers

NameTypeDescription

VTOKEN

string

Your API Token.

{"data":{"cancelled":true}}

Get an Order

GET https://api.vaultoro.com/v1/private/orders/{referenceId}

The endpoint allows you to retrieve a single order using the referenceId.

Path Parameters

NameTypeDescription

referenceId

string

The referenceId for the order that's returned on create

Headers

NameTypeDescription

VTOKEN

string

Your API token.

Last updated