🐳 TzPro Tezos NFT API

The TzPro NFT API provides the most complete view on Tezos NFT market activity including open and closed auctions, listings, offers, primary sales and successful trades across markets. Find open positions for an NFT collection, list trades executed by a specific wallet, compare prices and activity on different markets all with a single API.

Supported Markets

TzPro currently decodes the following NFT marketplace protocols

Aka
Artforge
Dogami Market
8bidou, 9bidou, 8scribo
fxhash v1, v2, fxtext
HEN v1, v2
Kalamint
Minterpop
Objkt.com v0, v1, v2
Pentas
Pixelpotus
Rarible Sales
Teia
Tezotopia
tzcolors
Tezos Domains
TzTacos
Versum

Missing something? To get your protocol or marketplace listed contact us at tzstats@trili.tech

Markets

Get info on each supported NFT market, list open sales and closed trades.

Get Market by address

Returns the NFT market at the specified address.

path Parameters

address

required

string <contract-address>

Market contract address.

Responses

Response Schema: application/json

contract	string <contract-address> Market contract address.
creator	string <address> Wallet address who signed the pool creation transaction.
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
first_block	integer <int64> Block height where pool was created.
first_time	string <date-time> Block timestamp where pool was created.
id	integer <int64> Internal database id.
kind	string Enum: "general" "auction" "minter" "private"
name	string Farm name.
tags	Array of strings Items Enum: "deprecated" "insecure" "broken" "non-transferable" "scam" … 2 more Optional tags for the ledger.

Response samples

Content type

application/json

{"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"creator": "tz1UBZUkXpKGhYsP5KtzDNqLLchwF4uHrGjw",
"entity": "HEN",
"first_block": 1365148,
"first_time": "2021-03-01T02:04:41Z",
"id": 2,
"kind": "general",
"name": "HicEtNunc v1",
"tags": [ ]
}

List Market events

Returns a list of events from the specified NFT market.

path Parameters

address

required

string <contract-address>

Market contract address.

query Parameters

	object Filter by sale type.
	object Filter by event type.
	object Filters by unique sale id in market contract.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filter by transaction signer.
	object Filter by transaction sender.
address	string <address> Filter by any address in signer, sender.
	object Filter by block height.
	object Filter by transaction date and time.
	object Filter by transaction hash.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

amount	string or null <bigint> Depends on `event_type`. Price per unit, auction bid price. May be zero.
block	integer <int64> Block height for the event.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
event_type	string Enum: "create_listing" "cancel_listing" "buy_listing" "create_offer" "cancel_offer" … 8 more
fee	string or null <bigint> Amount marketplace fee.
id	integer <int64> Internal database id.
name	string Market name.
num_units	integer <int64> Number of units sold.
royalty	string or null <bigint> Amount royalties.
royalty_bps	string <fixed> Royalty percentage in basis points.
sale_id	integer <int64> Unique sale id within market contract.
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
sender	string <address> Transaction sender address.
signer	string <address> Transaction signer address.
time	string <date-time> Block timestamp for the event.
token_id	string or null <bigint> Nft token id of sold item (only available if a single id is sold).
tx_fee	string <bigint> Transaction fee paid (raw, no decimals).
tx_hash	string <hash> Transaction hash related to the event.

Response samples

Content type

application/json

[{"amount": "3000000",
"block": 3501181,
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"event_type": "cancel_listing",
"id": 21637078,
"name": "HicEtNunc v1",
"num_units": 200,
"sale_id": 292629,
"sale_type": "listing",
"sender": "tz1TKYzCdNUf8msgg1VzgDZq3q9GTYgo5TWi",
"signer": "tz1TKYzCdNUf8msgg1VzgDZq3q9GTYgo5TWi",
"time": "2023-05-09T13:03:14Z",
"token_id": "137334",
"tx_fee": "1090",
"tx_hash": "ooKct47kaMGhybUq2ZxNV4rKjH5PSqG57Qkngw913tAmHHaVEbC"
}
]

List Market positions

Returns a list of positions from the specified NFT market.

path Parameters

address

required

string <contract-address>

Market contract address.

query Parameters

	object Filter by token category.
	object Filter by sale type.
	object Filter by sale status.
	object Filters by unique sale id in market contract.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filter by seller wallet address.
	object Filter by buyer wallet address.
address	string <address> Filter by any address in seller, buyer.
	object Filter by payment token address.
	object Filter by position opening block height.
	object Filter by position opening block timestamp.
	object Filter by position closing block height.
	object Filter by position closing block timestamp.
	object Filter by position `is_closed` flag.
with_closed	boolean Include closed positions when `true`.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

ask_price	string or null <bigint> Depends on `sale_type`. Asking price per unit or auction start price when seller is market maker.
bid_price	string or null <bigint> Depends on `sale_type`. Bid price per unit when buyer is market maker or auction highest bid.
buyer	string <address> Buyer wallet address. Only available when buyer is market maker or sale has successfully closed.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
close_block	integer <int64> Block height when position was closed.
close_time	string <date-time> Block timestamp position was closed.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
id	integer <int64> Internal database id.
is_closed	boolean Flag indicating whether position is historic (closed).
max_units	integer <int64> Total number of NFT units sold.
name	string Market name.
open_block	integer <int64> Block height when position was created.
open_time	string <date-time> Block timestamp position was created.
position_value_usd	string <fixed> Current USD value of the staking position (18 decimals).
royalty_bps	string <fixed> Royalty percentage in basis points.
sale_id	integer <int64> Unique sale id within market contract.
sale_status	string Enum: "active" "sold" "canceled" "expired"
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
seller	string <address> Seller wallet address. Only available when seller is market maker or a sale has successfully closed.
sold_units	integer <int64> Current number of successfully sold NFT units.
token_id	string or null <bigint> Nft token id of sold item (only available if a single id is sold).

Response samples

Content type

application/json

[{"ask_price": "1",
"bid_price": "0",
"buyer": "",
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"id": 3432679,
"is_closed": false,
"max_units": 1,
"name": "HicEtNunc v1",
"open_block": 2159592,
"open_time": "2022-03-01T14:39:04Z",
"royalty_bps": 1500,
"sale_id": 348154,
"seller": "tz1NQiYVMWtJXHMxB1H2RTEgwvYG8amBPZhH",
"sold_units": 0,
"status": "active",
"token_id": "684760",
"type": "listing"
}
]

List Market trades

Returns a list of trades from the specified NFT market.

path Parameters

address

required

string <contract-address>

Market contract address.

query Parameters

	object Filter by token category.
	object Filter by sale type.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filters by unique sale id in market contract.
	object Filter by seller wallet address.
	object Filter by buyer wallet address.
address	string <address> Filter by any address in seller, buyer.
	object Filter by payment token address.
	object Filter by block height.
	object Filter by transaction date and time.
	object Filter by transaction hash.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

block	integer <int64> Block height for the event.
buyer	string <address> Buyer wallet address.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
fee	string <bigint> Amount marketplace fee paid.
id	integer <int64> Internal database id.
name	string Market name.
num_units	integer <int64> Number of sold NFT units.
price	string <bigint> Price per Nft unit.
royalty	string <bigint> Amount royalties paid.
sale_id	integer <int64> Unique sale id within market contract.
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
seller	string <address> Seller wallet address.
time	string <date-time> Block timestamp for the event.
token_id	string <bigint> Nft token id of sold item (only available if a single id is sold).
tx_fee	string <bigint> Transaction fee paid (raw, no decimals).
tx_hash	string <hash> Transaction hash related to the event.

Response samples

Content type

application/json

[{"block": 3266195,
"buyer": "tz1hjmojPNfXpLLFAZPXu77imZb6b3QLB4HQ",
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"fee": "22500",
"id": 9261901,
"name": "HicEtNunc v1",
"num_units": 1,
"price": "900000",
"royalty": "0",
"seller": "tz1hmpFXWkxEVpv3U3Xjbzt5eXqZbMqSYjgr",
"time": "2023-03-28T20:28:59Z",
"token_id": "76999",
"tx_fee": "16750",
"tx_hash": "onvtzPWKJY4K33GRke3RicgS6Lg5gtbmQy5x3mWK5z37VqLCm1r",
"type": "listing"
}
]

Wallets

Get info in indiviudal traders like listing events, trades and open positions.

List Market events

Returns a list of NFT events for a wallet.

path Parameters

address

required

string

Wallet address.

query Parameters

	object Filters by market contract address.
	object Filter by entity label.
	object Filter by token category.
	object Filter by sale type.
	object Filter by event type.
	object Filters by unique sale id in market contract.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filter by transaction signer.
	object Filter by transaction sender.
	object Filter by block height.
	object Filter by transaction date and time.
	object Filter by transaction hash.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

amount	string or null <bigint> Depends on `event_type`. Price per unit, auction bid price. May be zero.
block	integer <int64> Block height for the event.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
event_type	string Enum: "create_listing" "cancel_listing" "buy_listing" "create_offer" "cancel_offer" … 8 more
fee	string or null <bigint> Amount marketplace fee.
id	integer <int64> Internal database id.
name	string Market name.
num_units	integer <int64> Number of units sold.
royalty	string or null <bigint> Amount royalties.
royalty_bps	string <fixed> Royalty percentage in basis points.
sale_id	integer <int64> Unique sale id within market contract.
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
sender	string <address> Transaction sender address.
signer	string <address> Transaction signer address.
time	string <date-time> Block timestamp for the event.
token_id	string or null <bigint> Nft token id of sold item (only available if a single id is sold).
tx_fee	string <bigint> Transaction fee paid (raw, no decimals).
tx_hash	string <hash> Transaction hash related to the event.

Response samples

Content type

application/json

[{"amount": "3000000",
"block": 3501181,
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"event_type": "cancel_listing",
"id": 21637078,
"name": "HicEtNunc v1",
"num_units": 200,
"sale_id": 292629,
"sale_type": "listing",
"sender": "tz1TKYzCdNUf8msgg1VzgDZq3q9GTYgo5TWi",
"signer": "tz1TKYzCdNUf8msgg1VzgDZq3q9GTYgo5TWi",
"time": "2023-05-09T13:03:14Z",
"token_id": "137334",
"tx_fee": "1090",
"tx_hash": "ooKct47kaMGhybUq2ZxNV4rKjH5PSqG57Qkngw913tAmHHaVEbC"
}
]

List Market positions

Returns a list of NFT positions for a wallet.

path Parameters

address

required

string

Wallet address.

query Parameters

	object Filters by NFT market contract address.
	object Filter by entity label.
	object Filter by token category.
	object Filter by sale type.
	object Filter by sale status.
	object Filters by unique sale id in market contract.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filter by seller wallet address.
	object Filter by buyer wallet address.
	object Filter by payment token address.
	object Filter by position opening block height.
	object Filter by position opening block timestamp.
	object Filter by position closing block height.
	object Filter by position closing block timestamp.
	object Filter by position `is_closed` flag.
with_closed	boolean Include closed positions when `true`.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

ask_price	string or null <bigint> Depends on `sale_type`. Asking price per unit or auction start price when seller is market maker.
bid_price	string or null <bigint> Depends on `sale_type`. Bid price per unit when buyer is market maker or auction highest bid.
buyer	string <address> Buyer wallet address. Only available when buyer is market maker or sale has successfully closed.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
close_block	integer <int64> Block height when position was closed.
close_time	string <date-time> Block timestamp position was closed.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
id	integer <int64> Internal database id.
is_closed	boolean Flag indicating whether position is historic (closed).
max_units	integer <int64> Total number of NFT units sold.
name	string Market name.
open_block	integer <int64> Block height when position was created.
open_time	string <date-time> Block timestamp position was created.
position_value_usd	string <fixed> Current USD value of the staking position (18 decimals).
royalty_bps	string <fixed> Royalty percentage in basis points.
sale_id	integer <int64> Unique sale id within market contract.
sale_status	string Enum: "active" "sold" "canceled" "expired"
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
seller	string <address> Seller wallet address. Only available when seller is market maker or a sale has successfully closed.
sold_units	integer <int64> Current number of successfully sold NFT units.
token_id	string or null <bigint> Nft token id of sold item (only available if a single id is sold).

Response samples

Content type

application/json

[{"ask_price": "1",
"bid_price": "0",
"buyer": "",
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"id": 3432679,
"is_closed": false,
"max_units": 1,
"name": "HicEtNunc v1",
"open_block": 2159592,
"open_time": "2022-03-01T14:39:04Z",
"royalty_bps": 1500,
"sale_id": 348154,
"seller": "tz1NQiYVMWtJXHMxB1H2RTEgwvYG8amBPZhH",
"sold_units": 0,
"status": "active",
"token_id": "684760",
"type": "listing"
}
]

List Market trades

Returns a list of NFT trades for a wallet.

path Parameters

address

required

string

Wallet address.

query Parameters

	object Filters by market contract address.
	object Filter by entity label.
	object Filter by token category.
	object Filter by sale type.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filter by seller wallet address.
	object Filter by buyer wallet address.
	object Filter by payment token address.
	object Filter by block height.
	object Filter by transaction date and time.
	object Filter by transaction hash.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

block	integer <int64> Block height for the event.
buyer	string <address> Buyer wallet address.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
fee	string <bigint> Amount marketplace fee paid.
id	integer <int64> Internal database id.
name	string Market name.
num_units	integer <int64> Number of sold NFT units.
price	string <bigint> Price per Nft unit.
royalty	string <bigint> Amount royalties paid.
sale_id	integer <int64> Unique sale id within market contract.
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
seller	string <address> Seller wallet address.
time	string <date-time> Block timestamp for the event.
token_id	string <bigint> Nft token id of sold item (only available if a single id is sold).
tx_fee	string <bigint> Transaction fee paid (raw, no decimals).
tx_hash	string <hash> Transaction hash related to the event.

Response samples

Content type

application/json

[{"block": 3266195,
"buyer": "tz1hjmojPNfXpLLFAZPXu77imZb6b3QLB4HQ",
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"fee": "22500",
"id": 9261901,
"name": "HicEtNunc v1",
"num_units": 1,
"price": "900000",
"royalty": "0",
"seller": "tz1hmpFXWkxEVpv3U3Xjbzt5eXqZbMqSYjgr",
"time": "2023-03-28T20:28:59Z",
"token_id": "76999",
"tx_fee": "16750",
"tx_hash": "onvtzPWKJY4K33GRke3RicgS6Lg5gtbmQy5x3mWK5z37VqLCm1r",
"type": "listing"
}
]

Firehose

List, filter and compare across all markets, trades and positions. Firehose access is limited to MAX subscribers only.

List all Markets

Returns a list of NFT markets.

query Parameters

	object Filters by market contract address.
	object Filter by entity label.
	object Filter by market creator.
	object Filter by market name.
	object Filter by market kind.
	object Filter by first block seen.
	object Filter by first time seen.
	object Filter by ledger tags.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

contract	string <contract-address> Market contract address.
creator	string <address> Wallet address who signed the pool creation transaction.
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
first_block	integer <int64> Block height where pool was created.
first_time	string <date-time> Block timestamp where pool was created.
id	integer <int64> Internal database id.
kind	string Enum: "general" "auction" "minter" "private"
name	string Farm name.
tags	Array of strings Items Enum: "deprecated" "insecure" "broken" "non-transferable" "scam" … 2 more Optional tags for the ledger.

Response samples

Content type

application/json

[{"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"creator": "tz1UBZUkXpKGhYsP5KtzDNqLLchwF4uHrGjw",
"entity": "HEN",
"first_block": 1365148,
"first_time": "2021-03-01T02:04:41Z",
"id": 2,
"kind": "general",
"name": "HicEtNunc v1",
"tags": [ ]
}
]

List all Market events

Returns a list of NFT market events.

query Parameters

	object Filters by market contract address.
	object Filter by entity label.
	object Filter by token category.
	object Filter by sale type.
	object Filter by event type.
	object Filters by unique sale id in market contract.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filter by transaction signer.
	object Filter by transaction sender.
address	string <address> Filter by any address in signer, sender.
	object Filter by block height.
	object Filter by transaction date and time.
	object Filter by transaction hash.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

amount	string or null <bigint> Depends on `event_type`. Price per unit, auction bid price. May be zero.
block	integer <int64> Block height for the event.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
event_type	string Enum: "create_listing" "cancel_listing" "buy_listing" "create_offer" "cancel_offer" … 8 more
fee	string or null <bigint> Amount marketplace fee.
id	integer <int64> Internal database id.
name	string Market name.
num_units	integer <int64> Number of units sold.
royalty	string or null <bigint> Amount royalties.
royalty_bps	string <fixed> Royalty percentage in basis points.
sale_id	integer <int64> Unique sale id within market contract.
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
sender	string <address> Transaction sender address.
signer	string <address> Transaction signer address.
time	string <date-time> Block timestamp for the event.
token_id	string or null <bigint> Nft token id of sold item (only available if a single id is sold).
tx_fee	string <bigint> Transaction fee paid (raw, no decimals).
tx_hash	string <hash> Transaction hash related to the event.

Response samples

Content type

application/json

[{"amount": "3000000",
"block": 3501181,
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"event_type": "cancel_listing",
"id": 21637078,
"name": "HicEtNunc v1",
"num_units": 200,
"sale_id": 292629,
"sale_type": "listing",
"sender": "tz1TKYzCdNUf8msgg1VzgDZq3q9GTYgo5TWi",
"signer": "tz1TKYzCdNUf8msgg1VzgDZq3q9GTYgo5TWi",
"time": "2023-05-09T13:03:14Z",
"token_id": "137334",
"tx_fee": "1090",
"tx_hash": "ooKct47kaMGhybUq2ZxNV4rKjH5PSqG57Qkngw913tAmHHaVEbC"
}
]

List all Market positions

Returns a list of NFT positions.

query Parameters

	object Filters by NFT market contract address.
	object Filter by entity label.
	object Filter by token category.
	object Filter by sale type.
	object Filter by sale status.
	object Filters by unique sale id in market contract.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filter by seller wallet address.
	object Filter by buyer wallet address.
address	string <address> Filter by any address in seller, buyer.
	object Filter by payment token address.
	object Filter by position opening block height.
	object Filter by position opening block timestamp.
	object Filter by position closing block height.
	object Filter by position closing block timestamp.
	object Filter by position `is_closed` flag.
with_closed	boolean Include closed positions when `true`.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

ask_price	string or null <bigint> Depends on `sale_type`. Asking price per unit or auction start price when seller is market maker.
bid_price	string or null <bigint> Depends on `sale_type`. Bid price per unit when buyer is market maker or auction highest bid.
buyer	string <address> Buyer wallet address. Only available when buyer is market maker or sale has successfully closed.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
close_block	integer <int64> Block height when position was closed.
close_time	string <date-time> Block timestamp position was closed.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
id	integer <int64> Internal database id.
is_closed	boolean Flag indicating whether position is historic (closed).
max_units	integer <int64> Total number of NFT units sold.
name	string Market name.
open_block	integer <int64> Block height when position was created.
open_time	string <date-time> Block timestamp position was created.
position_value_usd	string <fixed> Current USD value of the staking position (18 decimals).
royalty_bps	string <fixed> Royalty percentage in basis points.
sale_id	integer <int64> Unique sale id within market contract.
sale_status	string Enum: "active" "sold" "canceled" "expired"
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
seller	string <address> Seller wallet address. Only available when seller is market maker or a sale has successfully closed.
sold_units	integer <int64> Current number of successfully sold NFT units.
token_id	string or null <bigint> Nft token id of sold item (only available if a single id is sold).

Response samples

Content type

application/json

[{"ask_price": "1",
"bid_price": "0",
"buyer": "",
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"id": 3432679,
"is_closed": false,
"max_units": 1,
"name": "HicEtNunc v1",
"open_block": 2159592,
"open_time": "2022-03-01T14:39:04Z",
"royalty_bps": 1500,
"sale_id": 348154,
"seller": "tz1NQiYVMWtJXHMxB1H2RTEgwvYG8amBPZhH",
"sold_units": 0,
"status": "active",
"token_id": "684760",
"type": "listing"
}
]

List all Market trades

Returns a list of NFT trades.

query Parameters

	object Filters by market contract address.
	object Filter by entity label.
	object Filter by token category.
	object Filter by sale type.
	object Filters by NFT collection contract address.
	object Filters by NFT token id.
	object Filter by NFT token address.
	object Filter by seller wallet address.
	object Filter by buyer wallet address.
address	string <address> Filter by any address in seller, buyer.
	object Filter by payment token address.
	object Filter by block height.
	object Filter by transaction date and time.
	object Filter by transaction hash.
offset	integer <int32> >= 0 Default: 0 Skips a number of items at the front of a list. Applied after sorting. Use in combination with `limit` to paginate results. Performance hint: Prefer `cursor` in favor of offset/limit for pagination in large data sets. Example: `?offset=100`
limit	integer <int32> [ 0 .. 10000 ] Default: 100 Maximum number of items to return.
cursor	integer <int64> Skips list items with an `id` field less than the specified value (ascending sort order) or greater than (descending order). Performance hint: Always prefer this method in favor of offset/limit for pagination when an `id` field is present. Example: `?cursor=12345678`
order	string Default: "asc" Enum: "asc" "desc" Sorts results by `id` field in specified order.

Responses

Response Schema: application/json

Array

block	integer <int64> Block height for the event.
buyer	string <address> Buyer wallet address.
category	string Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more Token category.
collection	string <contract-address> Nft collection contract address of sold item(s).
contract	string <contract-address> Market contract address.
	object
entity	string Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more Custom entity label
fee	string <bigint> Amount marketplace fee paid.
id	integer <int64> Internal database id.
name	string Market name.
num_units	integer <int64> Number of sold NFT units.
price	string <bigint> Price per Nft unit.
royalty	string <bigint> Amount royalties paid.
sale_id	integer <int64> Unique sale id within market contract.
sale_type	string Enum: "listing" "offer" "collection_offer" "english_auction" "dutch_auction" … 4 more
seller	string <address> Seller wallet address.
time	string <date-time> Block timestamp for the event.
token_id	string <bigint> Nft token id of sold item (only available if a single id is sold).
tx_fee	string <bigint> Transaction fee paid (raw, no decimals).
tx_hash	string <hash> Transaction hash related to the event.

Response samples

Content type

application/json

[{"block": 3266195,
"buyer": "tz1hjmojPNfXpLLFAZPXu77imZb6b3QLB4HQ",
"category": "art",
"collection": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
"contract": "KT1Hkg5qeNhfwpKW4fXvq7HGZB9z2EnmCCA9",
"currency": {"decimals": 6,
"name": "Tez",
"symbol": "XTZ",
"token_kind": "tez",
"token_type": "native"
},
"entity": "HEN",
"fee": "22500",
"id": 9261901,
"name": "HicEtNunc v1",
"num_units": 1,
"price": "900000",
"royalty": "0",
"seller": "tz1hmpFXWkxEVpv3U3Xjbzt5eXqZbMqSYjgr",
"time": "2023-03-28T20:28:59Z",
"token_id": "76999",
"tx_fee": "16750",
"tx_hash": "onvtzPWKJY4K33GRke3RicgS6Lg5gtbmQy5x3mWK5z37VqLCm1r",
"type": "listing"
}
]