Order Book Data

This method returns all order book positions for a specific pair within the selected direction (buy or sell) and with pagination.

Details

GET https://api.pointpay.io/api/v1/public/book

Query Parameters

Name

Type

Description

Example

market*

STRING

Any public pair

BTC_USDT

side*

STRING

buy / sell

buy

offset

NUMERIC

How many last orders to skip (default = 0)

limit

NUMERIC

How many orders to display (default = 50, min = 1, max = 1000)

CURL Example

curl -X GET "https://api.pointpay.io/api/v1/public/book?market=BTC_USDT&side=sell&offset=0&limit=5" -H "accept: application/json"

Response parameters:

Name

Type

Description

NUMERIC

Order ID

market

STRING

Pair name

price

STRING

Order price

amount

STRING

Order amount (in 1st ticker of the pair)

left

STRING

Available order amount

type

STRING

Order type

side

STRING

Order side (sell / buy)

timestamp

NUMERIC

Order creation time (TimeStamp format)

takerFee

STRING

Order taker fee

makerFee

STRING

Order maker fee

dealStock

STRING

Executed amount in stock currency

dealMoney

STRING

Executed amount in money currency

Response example:

{
    "code": 200,
    "success": true,
    "message": "",
    "result": {
        "offset": 0,
        "limit": 5,
        "total": 302,
        "orders": [
        {
                "id": 19164608956,
                "market": "BTC_USDT",
                "price": "63363.0615556",
                "amount": "0.450231",
                "left": "0.450231",
                "type": "limit",
                "side": "sell",
                "timestamp": 1726835765.636000,
                "takerFee": "0",
                "makerFee": "0",
                "dealStock": "0",
                "dealMoney": "0"
        },
        ...
        ]
    }
}

Response example 1:

<html>

<head>
	<title>400 Bad Request</title>
</head>

<body>
	<center>
		<h1>400 Bad Request</h1>
	</center>
	<hr>
	<center>nginx</center>
</body>

</html>

This error occurs in the following cases:

One or more query parameters are invalid
The request contains invalid headers

Response example 2:

{
    "code": 400,
    "success": false,
    "message": "invalid input",
    "result": []
}

This error occurs in the following cases:

The query parameter market was not provided in the request.
One or more query parameters in the request contain invalid values.

Response example 3:

{
    "code": 400,
    "success": false,
    "message": {
        "side": [
            "The side is required."
        ]
    },
    "result": []
}

This error occurs in the following cases:

The query parameter side was not provided in the request.
The query parameter side was provided incorrectly.

Response example:

{
    "timestamp": 1660766043722,
    "status": 404,
    "error": "Not Found",
    "message": "",
    "path": "/api/v1/public/book-test"
}

This error occurs in the following cases:

The requested URL was not found. Please check the endpoint and try again

With Authentication

POST https://api.pointpay.io/api/v1/public/book

Headers

Name

Type

Description

X-TXC-APIKEY*

STRING

X-TXC-PAYLOAD*

STRING

Сonverted Base64 string containing body JSON

X-TXC-SIGNATURE*

STRING

Encrypted HmacSHA512 string containing body JSON with a API secret key

Request Body

Name

Type

Description

Example

market*

STRING

Any public pair

PXP_USDT

side*

STRING

buy / sell

sell

offset

NUMERIC

How many last orders to skip (default = 0)

limit

NUMERIC

How many orders to display (default = 50, min = 1, max = 1000)

request*

STRING

A request path without the domain name

/api/v1/public/book

nonce*

NUMERIC

A 13-character number that must always be greater than the nonce of the previous completed request (we suggest generating a nonce as the UNIX timestamp in milliseconds)

1704070810000

CURL Example

curl --location --request POST 'https://api.pointpay.io/api/v1/public/book' \
--header 'Content-Type: application/json' \
--header 'X-TXC-APIKEY: 0000000000XXXXXXXXXXXXXXXXX' \
--header 'X-TXC-PAYLOAD: 0000000000XXXXXXXXXXXXXXXXX' \
--header 'X-TXC-SIGNATURE: 0000000000XXXXXXXXXXXXXXXXX' \
--data-raw '{"market":"PXP_USDT","side":"sell","offset":1,"limit":10,"request":"/api/v1/public/book","nonce":1704070810000}'

Response example:

{
    "code": 200,
    "success": true,
    "message": "",
    "result": {
        "offset": 0,
        "limit": 50,
        "total": 1,
        "orders": [
            {
                "id": 1040986646,
                "market": "PXP_USDT",
                "price": "3.2",
                "amount": "1000",
                "left": "705.75",
                "type": "limit",
                "side": "sell",
                "timestamp": 1727773452.531000,
                "takerFee": "0.005",
                "makerFee": "0.005",
                "dealStock": "294.25",
                "dealMoney": "941.6"
            }
        ]
    }
}

Response example:

{
    "code": 400,
    "success": false,
    "message": "authentication failure",
    "result": []
}

This error occurs in the following cases:

The request was signed incorrectly.
Some of the provided parameters are incorrect.
The base URL or path is incorrect.

Response example:

{    
    "timestamp": 1727100903,
    "status": 404,
    "error": "Not Found",
    "message": "",
    "path": "/api/v1/public/public/test"
}

This error occurs in the following cases:

The request was made with undefined data and the service cannot find the data for response.

PreviousSpecific Pair Stats NextMarket History

Last updated 7 months ago

{ "code": 200, "success": true, "message": "", "result": { "offset": 0, "limit": 5, "total": 302, "orders": [ { "id": 19164608956, "market": "BTC_USDT", "price": "63363.0615556", "amount": "0.450231", "left": "0.450231", "type": "limit", "side": "sell", "timestamp": 1726835765.636000, "takerFee": "0", "makerFee": "0", "dealStock": "0", "dealMoney": "0" }, ... ] } }

curl --location --request POST 'https://api.pointpay.io/api/v1/public/book' \ --header 'Content-Type: application/json' \ --header 'X-TXC-APIKEY: 0000000000XXXXXXXXXXXXXXXXX' \ --header 'X-TXC-PAYLOAD: 0000000000XXXXXXXXXXXXXXXXX' \ --header 'X-TXC-SIGNATURE: 0000000000XXXXXXXXXXXXXXXXX' \ --data-raw '{"market":"PXP_USDT","side":"sell","offset":1,"limit":10,"request":"/api/v1/public/book","nonce":1704070810000}'

{ "code": 200, "success": true, "message": "", "result": { "offset": 0, "limit": 50, "total": 1, "orders": [ { "id": 1040986646, "market": "PXP_USDT", "price": "3.2", "amount": "1000", "left": "705.75", "type": "limit", "side": "sell", "timestamp": 1727773452.531000, "takerFee": "0.005", "makerFee": "0.005", "dealStock": "294.25", "dealMoney": "941.6" } ] } }