Single benchmark

https://api.koinju.io/benchmarks/:family/:timeframe/:id

Path Parameters

Variable

Type

Description

family

(required)

string

Benchmark family slug. The list of families s can be found on https://api.koinju.io/benchmarks

timeframe (required)

string

Timeframe name (15s or 1d)

id (required)

string

Benchmark ID.

Output format🧬

Variable

Format

Description

count

number

The number of families.

payload

object

The list of families.

payload variables

Variable

Format

Description

id

string

Family name.

timestamp

string

Timestamp of the benchmark.

timeframe

string

Timeframe name.

price

object

Last known price of the benchmark.

volume

object

Total volume exchanged.

markets

object

List of markets considered in the calculations.

hash

string

Hash of the benchmark.

price variables

Variable

Format

Description

value

string

Value of the price.

change_1h

string

Variation between the current price and the price from 1 hour ago.

change_24h

string

Variation between the current price and the price from 24 hours ago

percent_change_1h

string

Percentage of the variation between the current price and the price from 1 hour ago.

percent_change_24h

string

Percentage of the variation between the current price and the price from 24 hours ago.

volume variables

Variable

Format

Description

value

string

Value of the volume.

change_1h

string

Variation between the current volume and the volume from 1 hour ago.

change_24h

string

Variation between the current volume and the volume from 24 hours ago

percent_change_1h

string

Percentage of the variation between the current volume and the price from 1 hour ago.

percent_change_24h

string

Percentage of the variation between the current price and the price from 24 hours ago.

markets variables

Variable

Format

Description

list

object

List of markets, ordered by exchange, considered in the calculations.

number_of_trades

objet

Number of trades and its variations.

Example of reply

{
    "count": 1,
    "payload": [
        {
            "id": "KXTUR",
            "base": "XTZ",
            "quote": "usd",
            "timestamp": 1630072755000000000,
            "timeframe": "15s",
            "reference-rate": {
                "value": "4.76575",
                "change_1h": "0.0034125",
                "change_24H": "0.0034125",
                "percent_change_1h": "0.071655988262066685",
                "percent_change_24h": "0.071655988262066685"
            },
            "volume": {
                "value": "153.33",
                "change_1h": "-7546.01",
                "change_24H": "-7546.01",
                "percent_change_1h": "-98.008530601324269353",
                "percent_change_24h": "-98.008530601324269353"
            },
            "markets": {
                "list": {
                    "coinbase": [
                        "XTZ-USD"
                    ]
                },
                "number_of_trades": {
                    "value": 2,
                    "change_1h": "-30",
                    "change_24H": "-30",
                    "percent_change_1h": "-93.75",
                    "percent_change_24h": "-93.75"
                }
            },
            "hash": "0b99c375471aa9535d112bfaf6afa96fad2e74e4"
        }
    ]
}

Last updated