Depth List

This method returns the order book dept data for a specific pair with pagination. Used for analytics and monitoring of the order book depth.

Details

GET https://api.pointpay.io/api/v1/public/depth/result

Query Parameters

Name

Type

Description

Example

market*

STRING

Any public pair

BTC_USDT

limit

NUMERIC

Default 50; min 1; max 1000

CURL Example

curl -X GET "https://api.pointpay.io/api/v1/public/depth/result?market=BTC_USDT&limit=2" -H "accept: application/json"

Response parameters:

Name

Type

Description

type

STRING

Order type (asks = sell / bids = buy)

price

STRING

Order price

amount

STRING

Order amount (in 1st ticker of the pair)

Response example:

{
    "asks": [
        [
            "23504.38",            // price
            "0.254"                // amount                    
        ],
        [
            "23551.75245859",     //price
            "0.8"                 //amount
        ]
    ],
    "bids": [
        [
            "23465.23184735",     //price
            "0.89123"             //amount
        ],
        [
            "23499.61",          //price
            "0.9950856"          //amount
        ]
    ]
}

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": {
        "market": [
            "The market field is required."
        ]
    },
    "result": []
}

This error occurs in the following cases:

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

Response example:

{
    "timestamp": 1660766043722,
    "status": 404,
    "error": "Not Found",
    "message": "",
    "path": "/api/v1/public/depth/result-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/depth/result

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

BTC_USDT

limit

NUMERIC

Default 50; min 1; max 1000

request*

STRING

A request path without the domain name

/api/v1/public/depth/result

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/depth/result' \
--header 'Content-Type: application/json' \
--header 'X-TXC-APIKEY: 0000000000XXXXXXXXXXXXXXXXX' \
--header 'X-TXC-PAYLOAD: 0000000000XXXXXXXXXXXXXXXXX' \
--header 'X-TXC-SIGNATURE: 0000000000XXXXXXXXXXXXXXXXX' \
--data-raw '{"market":"BTC_USDT","limit":2,"request":"/api/v1/public/depth/result","nonce":1704070810000}'

Response example:

{
    "asks": [
        [
            "63791.208483",
            "0.034571"
        ],
        [
            "63791.248487",
            "0.0174"
        ]
    ],
    "bids": [
        [
            "63777.611601",
            "0.033688"
        ],
        [
            "63778.451517",
            "0.02699"
        ]
    ]
}

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": 1727100908,
    "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.

PreviousSymbols NextChart Data KLine

Last updated 7 months ago

{ "asks": [ [ "23504.38", // price "0.254" // amount ], [ "23551.75245859", //price "0.8" //amount ] ], "bids": [ [ "23465.23184735", //price "0.89123" //amount ], [ "23499.61", //price "0.9950856" //amount ] ] }

curl --location --request POST 'https://api.pointpay.io/api/v1/public/depth/result' \ --header 'Content-Type: application/json' \ --header 'X-TXC-APIKEY: 0000000000XXXXXXXXXXXXXXXXX' \ --header 'X-TXC-PAYLOAD: 0000000000XXXXXXXXXXXXXXXXX' \ --header 'X-TXC-SIGNATURE: 0000000000XXXXXXXXXXXXXXXXX' \ --data-raw '{"market":"BTC_USDT","limit":2,"request":"/api/v1/public/depth/result","nonce":1704070810000}'

{ "asks": [ [ "63791.208483", "0.034571" ], [ "63791.248487", "0.0174" ] ], "bids": [ [ "63777.611601", "0.033688" ], [ "63778.451517", "0.02699" ] ] }