data-controller

getTrendingCollection

Trending collection list. Sorted by special score, calculated in the following way: gmv * ( - 1) / 10000

Request

query Parameters

blockchain	string (OlapBlockchain) Blockchain Enum: "ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
period	string (OlapPeriod) Time period of trending statistics. Default: D7 Enum: "D1" "D7" "D30"
limit	integer <int32> Default: 10 Limit of records in trending statistics

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/data/trending/collections

Response samples

application/json

[{"id": "ETHEREUM:0xd8a5d498ab43ed060cb6629b97a19e3e4276dd9f",
"numberOfSales": {"value": 4847,
"changePercent": 1785.9922178988327
},
"volumeUsd": {"currency": "USD",
"value": 6353514.679736262,
"changePercent": 2415.324967987071
},
"volumeNative": {"currency": "ETH",
"value": 3095.884291383326
},
"floorPrice": {"currency": "ETH",
"value": 0.5749
}
}
]

getRaribleStats

Rarible-related statistics. Amount of items listed and sold on rarible platform and amount of minted items over all blockchains and all supported marketplaces

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/data/rarible/statistics

Response samples

application/json

{"sold": 434191371,
"minted": 150477545,
"listed": 145290
}

getUserLeaderboard

Users (top buyers/sellers) leaderboard. Calculated as traded worth for the period.

Request

path Parameters

entity

required

string (OlapUserType)

Type of users in leaderboard

Enum: "sellers" "buyers"

query Parameters

blockchain	string (OlapBlockchain) Blockchain Enum: "ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
source	string (OlapPlatformSource) Source Enum: "RARIBLE" "OPEN_SEA"
period	string (OlapPeriod) Time period of leaderboard. Default: D7 Enum: "D1" "D7" "D30"
limit	integer <int32> Default: 10 Limit of records in leaderboard

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/data/leaderboards/{entity}

Response samples

application/json

[{"id": "ETHEREUM:0xf1fa9ceb517f67646c9063f315f8b70cf26aa4e8",
"volumeUsd": {"currency": "USD",
"value": 18172788.19333184
},
"volumeNative": {"currency": "MATIC",
"value": 27343817.491841666
}
}
]

getCollectionMintsLeaderboard

Collections leaderboard based on mint activity

Request

query Parameters

blockchain	string (OlapBlockchain) Blockchain Enum: "ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
period	string (OlapLeaderboardPeriod) Time period of leaderboard Enum: "D1" "D7" "D30" "H6" "H1" "MIN30" "MIN5"
sort	string (OlapMintsLeaderboardSort) Default: "MINTED_DESC" Leaderboard sorting Enum: "MINTED_ASC" "MINTED_DESC" "COLLECTION_ASC" "COLLECTION_DESC"
limit	integer <int32> Default: 10 Limit of records in leaderboard
offset	integer <int32> Default: 0 Offset of records in leaderboard

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/data/leaderboards/collections/mints

Response samples

application/json

[{"id": "ETHEREUM:0x7e89a5e47cfdafd547ae8b2bc89590e0608941ae",
"minted": 1077,
"totalItemSupply": 1992,
"floorPrice": {"currency": "ETH",
"value": 0.0021
}
},
{"id": "ETHEREUM:0x5e6dd7b71bff0f893cef2045819bb6095bd17e80",
"minted": 607,
"totalItemSupply": 607,
"floorPrice": null
},
{"id": "ETHEREUM:0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
"minted": 178,
"totalItemSupply": 1984031,
"floorPrice": {"currency": "ETH",
"value": 5.295908e-22
}
}
]

getCollectionRankingByMints

Collections leaderboard based on mint activity

Request

query Parameters

blockchain	string (OlapBlockchain) Blockchain Enum: "ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
period	string (OlapLeaderboardPeriod) Time period of leaderboard Enum: "D1" "D7" "D30" "H6" "H1" "MIN30" "MIN5"
sort	string (OlapMintsLeaderboardSort) Default: "MINTED_DESC" Leaderboard sorting Enum: "MINTED_ASC" "MINTED_DESC" "COLLECTION_ASC" "COLLECTION_DESC"
limit	integer <int32> Default: 10 Limit of records in leaderboard
continuation	string Page reference. Taken from previous response

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/data/rankings/collections/mints

Response samples

application/json

{"continuation": "45325.07_ETHEREUM:0xe8f88d16f24255fcfab25959705d724406d67d9d",
"result": [{"id": "ETHEREUM:0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
"minted": 178,
"totalItemSupply": 1984031,
"floorPrice": {"currency": "ETH",
"value": 5.295908e-22
}
}
]
}

getCollectionLeaderboardDeprecated

Collections leaderboard by trade activity

Request

query Parameters

blockchain	string (OlapBlockchain) Blockchain Enum: "ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
ids	Array of strings Collection ids
period	string (OlapLeaderboardPeriod) Time period of leaderboard Enum: "D1" "D7" "D30" "H6" "H1" "MIN30" "MIN5"
minFloorPriceNative	number <bigdecimal> Show collections which floor price (native currency) more or equal than specified value
maxFloorPriceNative	number <bigdecimal> Show collections which floor price (native currency) less or equal than specified value
sort	string (OlapTradesLeaderboardSort) Default: "VOLUME_USD_DESC" Leaderboard sorting Enum: "VOLUME_USD_ASC" "VOLUME_USD_DESC" "COLLECTION_ASC" "COLLECTION_DESC"
limit	integer <int32> Default: 10 Limit of records in leaderboard
offset	integer <int32> Default: 0 Offset of records in leaderboard

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/data/leaderboards/collections

Response samples

application/json

[{"id": "ETHEREUM:0xe8f88d16f24255fcfab25959705d724406d67d9d",
"volumeUsd": {"currency": "USD",
"value": 45325.07,
"changePercent": -51.196335
},
"volumeNative": {"currency": "ETH",
"value": 23.95
},
"itemsBought": 1,
"floorPrice": {"currency": "ETH",
"value": 24
},
"listed": 33,
"totalItemSupply": 250,
"ownersCount": 187
}
]

getCollectionRankingByVolume

Collections leaderboard by trade activity

Request

query Parameters

blockchain	string (OlapBlockchain) Blockchain Enum: "ETHEREUM" "FLOW" "TEZOS" "POLYGON" "SOLANA" "IMMUTABLEX"
ids	Array of strings Collection ids
period	string (OlapLeaderboardPeriod) Time period for aggregation Enum: "D1" "D7" "D30" "H6" "H1" "MIN30" "MIN5"
minFloorPriceNative	number <bigdecimal> Show collections which floor price (native currency) more or equal than specified value
maxFloorPriceNative	number <bigdecimal> Show collections which floor price (native currency) less or equal than specified value
sort	string (OlapTradesLeaderboardSort) Default: "VOLUME_USD_DESC" Collections sorting Enum: "VOLUME_USD_ASC" "VOLUME_USD_DESC" "COLLECTION_ASC" "COLLECTION_DESC"
limit	integer <int32> Default: 10 Limit of records in leaderboard
continuation	string Page reference. Taken from previous response

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/data/rankings/collections/volume

Response samples

application/json

{"continuation": "45325.07_ETHEREUM:0xe8f88d16f24255fcfab25959705d724406d67d9d",
"result": [{"id": "ETHEREUM:0xe8f88d16f24255fcfab25959705d724406d67d9d",
"volumeUsd": {"currency": "USD",
"value": 45325.07,
"changePercent": -51.196335
},
"volumeNative": {"currency": "ETH",
"value": 23.95
},
"itemsBought": 1,
"floorPrice": {"currency": "ETH",
"value": 24,
"changePercent": -13.5332
},
"listed": 33,
"totalItemSupply": 250,
"ownersCount": 187
}
]
}

getTransactions

Get historical statistics about collection transactions

Request

path Parameters

collection

required

Identifier of collection

query Parameters

filters

string

Filters of statistics

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/transactions

Response samples

application/json

{"historicalDates": ["2022-05-05",
"2022-05-06",
"2022-05-07"
],
"historicalValues": [3602,
2566,
285
],
"currentValue": 260
}

getCollectionStats

Get general statistics about collection

Request

path Parameters

collection

required

Identifier of collection

query Parameters

currency

string (OlapCurrencyType)

Default: "USD"

Currency of statistics

Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL"

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/stats

Response samples

application/json

{"highestSale": 43.71,
"floorPrice": 1.45,
"marketCap": 14529,
"items": 10020,
"owners": 6472,
"volume": 41913.50477591493
}

getSellers

Get historical statistics about collection sellers

Request

path Parameters

collection

required

Identifier of collection

query Parameters

filters

string

Filters of statistics

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/sellers

Response samples

application/json

{"historicalDates": ["2022-05-05",
"2022-05-06",
"2022-05-07"
],
"historicalValues": [2744,
5487,
895
],
"currentValue": 1767
}

getPrices

Get historical statistics about collection items prices

Request

path Parameters

collection

required

Identifier of collection

query Parameters

currency	string (OlapCurrencyType) Default: "USD" Currency of statistics Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL"
filters	string Filters of statistics

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/prices

Response samples

application/json

{"dates": ["2022-05-05",
"2022-05-06",
"2022-05-07"
],
"avgPrices": [3.0356821472801507,
3.0695980858360876,
4.084722218806717
],
"medianPrices": [2.999,
3.1,
4.12
],
"minPrices": [0.45,
0.25,
2.26
],
"sumPrices": [10934.527094503102,
7876.5886882554005,
1164.1458323599143
]
}

getOwners

Get historical statistics about collection owners

Request

path Parameters

collection

required

Identifier of collection

query Parameters

filters

string

Filters of statistics

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/owners

Response samples

application/json

{"historicalDates": ["2022-05-05",
"2022-05-06",
"2022-05-07"
],
"historicalValues": [2215,
6381,
6363
],
"currentValue": 6476
}

getMarketcap

Get historical statistics about collection market cap

Request

path Parameters

collection

required

Identifier of collection

query Parameters

currency	string (OlapCurrencyType) Default: "USD" Currency of statistics Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL"
filters	string Filters of statistics

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/marketcap

Response samples

application/json

{"historicalDates": ["2022-05-05",
"2022-05-06",
"2022-05-07"
],
"historicalValues": [6800,
16683.68,
19038
],
"currentValue": 14529
}

getGmv

Get historical statistics about collection gross merchandise value

Request

path Parameters

collection

required

Identifier of collection

query Parameters

currency	string (OlapCurrencyType) Default: "USD" Currency of statistics Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL"
period	string (OlapPeriod) Time period of statistics. Default: D1 Enum: "D1" "D7" "D30"
filters	string Filters of statistics

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/gmv

Response samples

application/json

{"historicalDates": ["2022-05-05",
"2022-05-06",
"2022-05-07"
],
"historicalValues": [10934.527094503102,
7876.5886882554005,
1164.1458323599143
],
"currentValue": 498.19370351666873
}

getFloorPrice

Get historical statistics about collection item floor price

Request

path Parameters

collection

required

Identifier of collection

query Parameters

currency	string (OlapCurrencyType) Default: "USD" Currency of statistics Enum: "USD" "ETH" "XTZ" "FLOW" "MATIC" "SOL"
filters	string Filters of statistics

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/floorPrice

Response samples

application/json

{"historicalDates": ["2022-05-05",
"2022-05-06",
"2022-05-07"
],
"historicalValues": [1.7,
1.69,
1.9
],
"currentValue": 1.45
}

getBuyers

Get historical statistics about collection buyers

Request

path Parameters

collection

required

Identifier of collection

query Parameters

filters

string

Filters of statistics

Responses

200

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/buyers

Response samples

application/json

{"historicalDates": ["2022-05-08",
"2022-05-09",
"2022-05-10"
],
"historicalValues": [524,
791,
1619
],
"currentValue": 1767
}