objkt.com public API v3
Welcome to objkt.com public API documentation. This documentation is subject to change as the API changes.
We provide this API as a best-effort, free service.
Updates
To keep up with API changes, please sign up for our API mailing list below. We will only send emails when we have to warn about upcoming breaking changes.
v3 Documentation
Limits
- 120 requests per minute
- Max 500 results, paginate based on the last pk/id/timestamp to retrieve everything
- The API does not provide subscriptions / live queries / websocket
Schema
All queries exist as entity
and entity_pk
, the latter letting you query directly by Primary Key.
Entities
attribute
An item from a tzip-21 attributes array.
id
(id
)name
(string
)type
(string
)value
(string
)attribute_counts
relationship to a collection offa2_attribute_count
tokens
relationship to a collection oftoken_attribute
currency
id
(id
)type
(fa1.2
|fa2
|tez
)decimals
(integer
), how many decimals are used (e.g. Tezos has 6 decimals:1_000_000 = 1xtz
)fa
relationship to a singlefa
fa_contract
token
relationship to a singletoken
token_pk
dutch_auction
Dutch auctions are price drop auctions.
WARNING Not all auctions are valid, some may:
- contain invalid royalties, or
- the seller might have lost the "operator" permission required to execute a sale, or
- the seller might not have the auctioned token anymore.
To retrieve active and valid auctions use dutch_auction_active
id
(id
)bigmap_key
(integer
), bigmap key of this dutch_auction in thismarketplace_contract
amount
(integer
), how many editions are for sale in this listingamount_left
(integer
), how many editions have not yet been sold on this listingend_price
(integer
)end_price_xtz
(integer
)end_time
(utc_datetime
)expiry
(utc_datetime
)hash
(string
)level
(integer
), block levelshares
([{}]
), royalties mapstart_price
(integer
)start_price_xtz
(integer
)start_time
(utc_datetime
)status
(active
|concluded
|cancelled
)timestamp
(utc_datetime
)update_level
(integer
)update_timestamp
(utc_datetime
)ophash
(string
), operation hashupdate_ophash
(string
)valid_royalties
(boolean
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
currency
relationship to a singlecurrency
currency_id
token
relationship to a singletoken
token_pk
seller
relationship to a singleholder
seller_address
fa
relationship to a singlefa
fa_contract
sales
relationship to a collection ofdutch_auction_sale
dutch_auction_active
Only the active and valid dutch auctions.
It is the recommended way of fetching active dutch auctions.
id
(id
)bigmap_key
(integer
)amount
(integer
)amount_left
(integer
)end_price
(integer
)end_price_xtz
(integer
)end_time
(utc_datetime
)expiry
(utc_datetime
)hash
(string
)level
(integer
)shares
([{}]
)start_price
(integer
)start_price_xtz
(integer
)start_time
(utc_datetime
)timestamp
(utc_datetime
)update_level
(integer
)update_timestamp
(utc_datetime
)ophash
(string
)update_ophash
(string
)marketplace_contract
(string
)currency_id
(id
)token_pk
(id
)seller_address
(string
)fa_contract
(string
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
currency
relationship to a singlecurrency
currency_id
token
relationship to a singletoken
token_pk
seller
relationship to a singleholder
seller_address
fa
relationship to a singlefa
fa_contract
sales
relationship to a collection ofdutch_auction_sale
dutch_auction_sale
id
(id
)amount
(integer
)level
(integer
)price
(integer
)price_xtz
(integer
)timestamp
(utc_datetime
)ophash
(string
)currency
relationship to a singlecurrency
currency_id
dutch_auction
relationship to a singledutch_auction
dutch_auction_id
marketplace
relationship to a singlemarketplace_contract
marketplace_contract
token
relationship to a singletoken
token_pk
seller
relationship to a singleholder
seller_address
buyer
relationship to a singleholder
buyer_address
sender
relationship to a singleholder
sender_address
english_auction
English auctions are highest bid auctions.
WARNING Not all auctions are valid, some may:
- contain invalid royalties, or
- the seller might have lost the "operator" permission required to execute a sale, or
- the seller might not have the auctioned token anymore.
To retrieve active and valid auctions use english_auction_active
id
(id
)bigmap_key
(integer
), bigmap key of this english_auction in thismarketplace_contract
end_time
(utc_datetime
)extension_time
(integer
)hash
(string
)highest_bid
(integer
)highest_bid_xtz
(integer
)level
(integer
), block levelprice_increment
(integer
)price_increment_xtz
(integer
)reserve
(integer
)reserve_xtz
(integer
)shares
([{}]
), royalties mapreferral_bonus
(integer
)duration
(integer
)start_time
(utc_datetime
)status
(active
|concluded
|cancelled
)timestamp
(utc_datetime
)update_level
(integer
)update_timestamp
(utc_datetime
)ophash
(string
), operation hashupdate_ophash
(string
)valid_royalties
(boolean
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
currency
relationship to a singlecurrency
currency_id
token
relationship to a singletoken
token_pk
seller
relationship to a singleholder
seller_address
highest_bidder
relationship to a singleholder
highest_bidder_address
fa
relationship to a singlefa
fa_contract
bids
relationship to a collection ofenglish_auction_bid
english_auction_active
Only the active and valid english auctions.
It is the recommended way of fetching active english auctions.
id
(id
)bigmap_key
(integer
)end_time
(utc_datetime
)extension_time
(integer
)hash
(string
)highest_bid
(integer
)highest_bid_xtz
(integer
)level
(integer
)price_increment
(integer
)price_increment_xtz
(integer
)reserve
(integer
)reserve_xtz
(integer
)shares
([{}]
)start_time
(utc_datetime
)timestamp
(utc_datetime
)update_level
(integer
)update_timestamp
(utc_datetime
)ophash
(string
)update_ophash
(string
)marketplace_contract
(string
)currency_id
(id
)token_pk
(id
)seller_address
(string
)highest_bidder_address
(string
)fa_contract
(string
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
currency
relationship to a singlecurrency
currency_id
token
relationship to a singletoken
token_pk
seller
relationship to a singleholder
seller_address
highest_bidder
relationship to a singleholder
highest_bidder_address
fa
relationship to a singlefa
fa_contract
bids
relationship to a collection ofenglish_auction_bid
english_auction_bid
id
(id
)amount
(integer
)amount_xtz
(integer
)referrers
(map
)level
(integer
)timestamp
(utc_datetime
)ophash
(string
)currency
relationship to a singlecurrency
currency_id
marketplace
relationship to a singlemarketplace_contract
marketplace_contract
bidder
relationship to a singleholder
bidder_address
auction
relationship to a singleenglish_auction
english_auction_id
event
Events are generated from blockchain actions
id
(id
)amount
(integer
)event_type
(mint
|create_collection
|transfer
|open_edition_create
|open_edition_update
|open_edition_buy
)marketplace_event_type
(list_create
|list_cancel
|list_buy
|english_auction_create
|english_auction_cancel
|english_auction_bid
|english_auction_settle
|dutch_auction_create
|dutch_auction_cancel
|dutch_auction_buy
|offer_create
|offer_accept
|offer_cancel
|offer_floor_create
|offer_floor_accept
|offer_floor_cancel
)price
(integer
)price_xtz
(integer
)timestamp
(utc_datetime
)ophash
(string
)level
(integer
)reverted
(boolean
)marketplace_object_id
(integer
)currency
relationship to a singlecurrency
currency_id
creator
relationship to a singleholder
creator_address
recipient
relationship to a singleholder
recipient_address
fa
relationship to a singlefa
fa_contract
marketplace
relationship to a singlemarketplace_contract
marketplace_contract
token
relationship to a singletoken
token_pk
fa
A Tezos contract, represents either an FA2 contract or an FA1.2 contract (see type
.)
Holds info about a collection and different stats.
contract
(string
)originated
(string
), contract that originated this contractactive_auctions
(integer
), number of active auctionsactive_listing
(integer
), number of active listingscategory
(string
)collection_id
(string
)collection_type
(curated
|auto
|generative
|artist
|open
|custom
|open_edition
),artist
|open_edition
means a collection created directly on objkt.com,curated
means a collection of pieces from different artists who were hand-picked,generative
means a collection where tokens were generated from a set of rules/layers,open
means a collection where anyone can mint anything.index_contract_metadata
(boolean
)description
(string
)floor_price
(integer
), cheapest listing in this collection in xtzitems
(integer
), number of tokens in this collectioneditions
(integer
), total number of editions of all tokens in this collectiontoken_metadata_view
(boolean
)last_metadata_update
(utc_datetime
)ledger_type
(other
|nft_asset
|multi_asset
)level
(integer
)live
(boolean
)logo
(string
)metadata
(string
)name
(string
), collection name (or asset name for FA1.2 contract)owners
(integer
), number of unique wallets holding a token from this collectionpath
(string
)short_name
(string
)timestamp
(utc_datetime
)token_link
(string
)twitter
(string
), Twitter username used to link from collection pagetype
(fa1.2
|fa2
)tzip16_key
(string
)volume_24h
(integer
)volume_total
(integer
)website
(string
), Website URL shown on collection pageverified_creators
([string]
)creator
relationship to a singleholder
creator_address
collaborators
relationship to a collection ofinvitation
tokens
relationship to a collection oftoken
events
relationship to a collection ofevent
attribute_counts
relationship to a collection offa2_attribute_count
listings
relationship to a collection oflisting
listings_active
relationship to a collection oflisting_active
offers
relationship to a collection ofoffer
offers_active
relationship to a collection ofoffer_active
english_auctions
relationship to a collection ofenglish_auction
english_auctions_active
relationship to a collection ofenglish_auction_active
dutch_auctions
relationship to a collection ofdutch_auction
dutch_auctions_active
relationship to a collection ofdutch_auction_active
open_edition
relationship to a collection ofopen_edition
open_edition_active
relationship to a collection ofopen_edition_active
fa2_attribute_count
Keeps track of attribute rarity per fa2.
id
(id
)tokens
(integer
), how many tokens have this attribute in this fa2editions
(integer
), how many tokens have this attribute in this fa2fa
relationship to a singlefa
fa_contract
attribute
relationship to a singleattribute
attribute_id
gallery_attribute_count
Keeps track of attribute rarity per gallery.
id
(id
)tokens
(integer
), how many tokens have this attribute in this galleryeditions
(integer
), how many tokens have this attribute in this gallerygallery_pk
(integer
)attribute
relationship to a singleattribute
attribute_id
holder
A holder
is an implicit or originated tezos account.
address
(string
)flag
(none
|banned
|flagged
|removed
)alias
(string
), Tezos Profiles alias (basic information)logo
(string
), Tezos Profiles logo (basic information)website
(string
), Tezos Profiles website (basic information)description
(string
), Tezos Profiles description (basic information)discord
(string
), Tezos Profiles verified discord accountethereum
(string
), Tezos Profiles verified ethereum accountfacebook
(string
), Tezos Profiles verified facebook accountgithub
(string
), Tezos Profiles verified github accountgitlab
(string
), Tezos Profiles verified gitlab accountinstagram
(string
), Tezos Profiles verified instagram accountmedium
(string
), Tezos Profiles verified medium accountreddit
(string
), Tezos Profiles verified reddit accountdns
(string
), Tezos Profiles verified dns accountslack
(string
), Tezos Profiles verified slack accounttelegram
(string
), Tezos Profiles verified telegram accounttwitter
(string
), Tezos Profiles verified twitter accounttzdomain
(string
), Tezos Domains reverse recordoffers_created
relationship to a collection ofoffer
offers_active
relationship to a collection ofoffer_active
offers_accepted
relationship to a collection ofoffer
english_auctions_created
relationship to a collection ofenglish_auction
english_auctions_active
relationship to a collection ofenglish_auction_active
english_auctions_highest_bidder
relationship to a collection ofenglish_auction
english_auction_bids
relationship to a collection ofenglish_auction_bid
events_creator
relationship to a collection ofevent
events_recipient
relationship to a collection ofevent
fa2s_created
relationship to a collection offa
listings_created
relationship to a collection oflisting
listings_active
relationship to a collection oflisting_active
listings_bought
relationship to a collection oflisting_sale
listings_sold
relationship to a collection oflisting_sale
dutch_auctions_created
relationship to a collection ofdutch_auction
dutch_auctions_active
relationship to a collection ofdutch_auction_active
dutch_auctions_bought
relationship to a collection ofdutch_auction_sale
dutch_auctions_sold
relationship to a collection ofdutch_auction_sale
open_edition_created
relationship to a collection ofopen_edition
open_edition_active
relationship to a collection ofopen_edition_active
sales_stats
relationship to a collection ofsales_stat
owner_operators
relationship to a collection oftoken_operator
operator_operators
relationship to a collection oftoken_operator
receiver_royalties
relationship to a collection ofroyalties
created_tokens
relationship to a collection oftoken_creator
held_tokens
relationship to a collection oftoken_holder
collaborations
relationship to a collection ofinvitation
invitation
An on-chain collaboration invitation
id
(id
)status
(invited
|accepted
)timestamp
(utc_datetime
)update_timestamp
(utc_datetime
)level
(integer
)fa
relationship to a singlefa
fa_contract
holder
relationship to a singleholder
collaborator_address
listing
A Listing
is something listed for direct sale, for instance: "I am selling X editions of token Y for Z xtz each."
WARNING Not all listings are valid, some may:
- contain invalid royalties, or
- the seller might have lost the "operator" permission required to execute a sale, or
- the seller might not have the auctioned token anymore.
To retrieve active and valid listings use listing_active
id
(id
)bigmap_key
(integer
), bigmap key of this listing in thismarketplace_contract
amount
(integer
), how many editions are for sale in this listingamount_left
(integer
), how many editions have not yet been sold on this listinglevel
(integer
), block levelprice
(integer
), price per edition incurrency
price_xtz
(integer
), price per edition converted to xtz, reflects the equivalent xtz price while the listing is "active"start_price
(integer
)end_price
(integer
)shares
([{}]
), royalties mapstatus
(active
|concluded
|cancelled
)expiry
(utc_datetime
)timestamp
(utc_datetime
)update_level
(integer
)update_timestamp
(utc_datetime
)ophash
(string
), operation hashupdate_ophash
(string
)valid_royalties
(boolean
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
currency
relationship to a singlecurrency
currency_id
token
relationship to a singletoken
token_pk
fa
relationship to a singlefa
fa_contract
seller
relationship to a singleholder
seller_address
target
relationship to a singleholder
target_address
listing_sales
relationship to a collection oflisting_sale
listing_active
Only the active and valid listings.
It is the recommended way of fetching active listings.
id
(id
)bigmap_key
(integer
)amount
(integer
)amount_left
(integer
)level
(integer
)price
(integer
)price_xtz
(integer
)start_price
(integer
)end_price
(integer
)shares
([{}]
)expiry
(utc_datetime
)timestamp
(utc_datetime
)update_level
(integer
)update_timestamp
(utc_datetime
)ophash
(string
)update_ophash
(string
)marketplace_contract
(string
)currency_id
(id
)token_pk
(id
)fa_contract
(string
)seller_address
(string
)target_address
(string
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
currency
relationship to a singlecurrency
currency_id
token
relationship to a singletoken
token_pk
fa
relationship to a singlefa
fa_contract
seller
relationship to a singleholder
seller_address
target
relationship to a singleholder
target_address
listing_sale
id
(id
)amount
(integer
)level
(integer
)price
(integer
)price_xtz
(integer
)timestamp
(utc_datetime
)ophash
(string
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
listing
relationship to a singlelisting
listing_id
token
relationship to a singletoken
token_pk
seller
relationship to a singleholder
seller_address
buyer
relationship to a singleholder
buyer_address
sender
relationship to a singleholder
sender_address
marketplace_contract
Contracts related to marketplace things (listings, offers, auctions, …)
We file MarketplaceContract
s into groups and subgroups, and assign them an easily recognizable name.
contract
(string
)name
(string
), the name we chose, it is not necessarily the 'official', on-chain metadata name of this contractgroup
(string
), the 'organization' to which this contract belongssubgroup
(string
),marketplace
when it handles marketplace, i.e. listings/offers (it can also handle other things such as auctions),english
when it only handles english auctions,dutch
when it only handles dutch auctionsevents
relationship to a collection ofevent
offer
An Offer
is a proposal made by a buyer to buy something, for instance: "I am offering X xtz for one edition of token Y."
A "collection offer" (aka "floor offer") is an offer that is valid for any item of a specific collection, for instance: "I am offering X xtz for any Tezzardz."
WARNING Not all offers are valid, some may contain invalid royalties.
To retrieve active and valid offers use offer_active
id
(id
)bigmap_key
(integer
), bigmap key of this offer in thismarketplace_contract
price
(integer
)price_xtz
(integer
)shares
([{}]
), royalties mapcollection_offer
(string
)status
(active
|concluded
|cancelled
)expiry
(utc_datetime
)ophash
(string
)update_ophash
(string
)level
(integer
)update_level
(integer
)timestamp
(utc_datetime
)update_timestamp
(utc_datetime
)valid_royalties
(boolean
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
currency
relationship to a singlecurrency
currency_id
token
relationship to a singletoken
token_pk
buyer
relationship to a singleholder
buyer_address
seller
relationship to a singleholder
seller_address
target
relationship to a singleholder
target_address
fa
relationship to a singlefa
fa_contract
offer_active
Only the active and valid offers.
It is the recommended way of fetching active offers.
id
(id
)bigmap_key
(integer
)price
(integer
)price_xtz
(integer
)shares
([{}]
)collection_offer
(string
)expiry
(utc_datetime
)ophash
(string
)update_ophash
(string
)level
(integer
)update_level
(integer
)timestamp
(utc_datetime
)update_timestamp
(utc_datetime
)marketplace_contract
(string
)currency_id
(id
)token_pk
(id
)buyer_address
(string
)seller_address
(string
)target_address
(string
)fa_contract
(string
)marketplace
relationship to a singlemarketplace_contract
marketplace_contract
currency
relationship to a singlecurrency
currency_id
token
relationship to a singletoken
token_pk
buyer
relationship to a singleholder
buyer_address
seller
relationship to a singleholder
seller_address
target
relationship to a singleholder
target_address
fa
relationship to a singlefa
fa_contract
open_edition
start_time
(utc_datetime
)end_time
(utc_datetime
)price
(integer
)shares_total
(integer
)shares
(map
)burn_recipe
([{}]
)max_per_wallet
(integer
)airdrop_capacity
(integer
)timestamp
(utc_datetime
)level
(integer
)ophash
(string
)token
relationship to a singletoken
token_pk
seller
relationship to a singleholder
seller_address
fa
relationship to a singlefa
fa_contract
open_edition_active
Only the active and valid open editions.
It is the recommended way of fetching active open editions.
token_pk
(id
)start_time
(utc_datetime
)end_time
(utc_datetime
)price
(integer
)shares_total
(integer
)shares
(map
)burn_recipe
([{}]
)max_per_wallet
(integer
)airdrop_capacity
(integer
)timestamp
(utc_datetime
)level
(integer
)ophash
(string
)seller_address
(string
)fa_contract
(string
)token
relationship to a singletoken
token_pk
seller
relationship to a singleholder
seller_address
fa
relationship to a singlefa
fa_contract
royalties
id
(id
)decimals
(integer
)amount
(integer
)holder
relationship to a singleholder
receiver_address
token
relationship to a singletoken
token_pk
sales_stat
id
(id
)interval_days
(integer
)rank
(integer
)type
(buyer
|seller
|artist
)volume
(integer
)subject
relationship to a singleholder
subject_address
tag
An item from a tzip-21 tags array.
id
(id
)name
(string
)token_count
(integer
)tokens
relationship to a collection oftoken_tag
tezos_storage
id
(id
)tzip16_key
(string
)tzip16_value
(string
)fa
relationship to a singlefa
fa_contract
token
pk
(id
)token_id
(string
)artifact_uri
(string
)description
(string
)display_uri
(string
)extra
([{}]
)highest_offer
(integer
)last_listed
(utc_datetime
)last_metadata_update
(utc_datetime
)level
(integer
)lowest_ask
(integer
)metadata
(string
)mime
(string
)symbol
(string
)decimals
(integer
)is_boolean_amount
(boolean
)rights
(string
)supply
(integer
)thumbnail_uri
(string
)timestamp
(utc_datetime
)name
(string
)ophash
(string
)flag
(none
|banned
|flagged
|removed
)metadata_status
(locked
|updatable
|unknown
)average
(integer
)accessibility
(map
)content_rating
(string
)tzip16_key
(string
)fa
relationship to a singlefa
fa_contract
open_edition
relationship to a singleopen_edition
pk
open_edition_active
relationship to a singleopen_edition_active
pk
events
relationship to a collection ofevent
operators
relationship to a collection oftoken_operator
royalties
relationship to a collection ofroyalties
listings
relationship to a collection oflisting
listings_active
relationship to a collection oflisting_active
listing_sales
relationship to a collection oflisting_sale
offers
relationship to a collection ofoffer
offers_active
relationship to a collection ofoffer_active
dutch_auctions
relationship to a collection ofdutch_auction
dutch_auctions_active
relationship to a collection ofdutch_auction_active
english_auctions
relationship to a collection ofenglish_auction
english_auctions_active
relationship to a collection ofenglish_auction_active
creators
relationship to a collection oftoken_creator
holders
relationship to a collection oftoken_holder
attributes
relationship to a collection oftoken_attribute
tags
relationship to a collection oftoken_tag
token_attribute
id
(id
)token
relationship to a singletoken
token_pk
attribute
relationship to a singleattribute
attribute_id
token_creator
verified
(boolean
)holder
relationship to a singleholder
creator_address
token
relationship to a singletoken
token_pk
token_holder
last_incremented_at
(utc_datetime
)quantity
(decimal
)holder
relationship to a singleholder
holder_address
token
relationship to a singletoken
token_pk
token_operator
id
(id
)allowed
(boolean
)amount
(decimal
)owner
relationship to a singleholder
owner_address
operator
relationship to a singleholder
operator_address
token
relationship to a singletoken
token_pk
token_registry
address
(string
)active
(boolean
)type
(fa1.2
|fa2
|tez
)beneficiary
(string
)fee
(integer
)
token_tag
tzd_domain
Tezos Domains domains.
id
(string
)expiry
(utc_datetime
)owner
(string
)token
relationship to a singletoken
token_pk
tzd_tld
relationship to a singletzd_tld
tzd_tld_id
records
relationship to a collection oftzd_record
tzd_record
id
(string
)domain
relationship to a singletzd_domain
domain_id
target
relationship to a singleholder
target_address
tzd_tld
Tezos Domains TLDs.
id
(string
), the TLD, e.g.tez
for.tez
owner
(string
), the TLDRegistrar contract addressdomains
relationship to a collection oftzd_domain