data-controller

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

SecurityApiKeyAuth
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/data/rarible/statistics
Response samples
application/json
{
  • "sold": 434191371,
  • "minted": 150477545,
  • "listed": 145290
}

getUserRankingByVolume

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

SecurityApiKeyAuth
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 (OlapLeaderboardPeriod)

Time period of leaderboard. Default: D7

Enum: "D1" "D7" "D30" "H6" "H1" "MIN30" "MIN5" "ALL"
limit
integer <int32>
Default: 10

Limit of records in leaderboard

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/data/rankings/{entity}/volume
Response samples
application/json
{
  • "result": [
    ]
}

getCollectionRankingByMints

Collections leaderboard based on mint activity

SecurityApiKeyAuth
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" "ALL"
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

OK

400

Bad Request

500

Internal Server Error

get/v0.1/data/rankings/collections/mints
Response samples
application/json
{
  • "continuation": "45325.07_ETHEREUM:0xe8f88d16f24255fcfab25959705d724406d67d9d",
  • "result": [
    ]
}

getCollectionRankingByVolume

Collections leaderboard by trade activity

SecurityApiKeyAuth
Request
query Parameters
source
string (OlapTradesLeaderboardSourceGroup)

Group of platform used for volume calculation and collection ranging.

Enum: "RARIBLE" "EXTERNAL"
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" "ALL"
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

OK

400

Bad Request

500

Internal Server Error

get/v0.1/data/rankings/collections/volume
Response samples
application/json
{
  • "continuation": "45325.07_ETHEREUM:0xe8f88d16f24255fcfab25959705d724406d67d9d",
  • "result": [
    ]
}

getTransactions

Get historical statistics about collection transactions

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (OlapCollectionPattern) ^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...

Identifier of collection

query Parameters
filters
string

Filters of statistics

Responses
200

OK

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/transactions
Response samples
application/json
{
  • "historicalDates": [
    ],
  • "historicalValues": [
    ],
  • "currentValue": 260
}

getCollectionStats

Get general statistics about collection

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (OlapCollectionPattern) ^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...

Identifier of collection

query Parameters
currency
string (OlapCurrencyType)
Default: "USD"

Currency of statistics

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

OK

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

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (OlapCollectionPattern) ^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...

Identifier of collection

query Parameters
filters
string

Filters of statistics

Responses
200

OK

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/sellers
Response samples
application/json
{
  • "historicalDates": [
    ],
  • "historicalValues": [
    ],
  • "currentValue": 1767
}

getGmv

Get historical statistics about collection gross merchandise value

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (OlapCollectionPattern) ^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...

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

OK

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/gmv
Response samples
application/json
{
  • "historicalDates": [
    ],
  • "historicalValues": [
    ],
  • "currentValue": 498.19370351666873
}

getFloorPrice

Get historical statistics about collection item floor price

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (OlapCollectionPattern) ^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...

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

OK

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/floorPrice
Response samples
application/json
{
  • "historicalDates": [
    ],
  • "historicalValues": [
    ],
  • "currentValue": 1.45
}

getBuyers

Get historical statistics about collection buyers

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (OlapCollectionPattern) ^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...

Identifier of collection

query Parameters
filters
string

Filters of statistics

Responses
200

OK

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/buyers
Response samples
application/json
{
  • "historicalDates": [
    ],
  • "historicalValues": [
    ],
  • "currentValue": 1767
}

getListed

Get historical statistics of collection listed count

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (OlapCollectionPattern) ^(ETHEREUM|FLOW|TEZOS|POLYGON|SOLANA|IMMUTABL...

Identifier of collection

Responses
200

OK

400

Bad Request

404

Not found

500

Internal Server Error

get/v0.1/data/collections/{collection}/listed
Response samples
application/json
{
  • "historicalDates": [
    ],
  • "historicalValues": [
    ],
  • "currentValue": 1767
}