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.

View mailing list archive.

v3 Documentation

Limits

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.

currency

dutch_auction

Dutch auctions are price drop auctions.

WARNING Not all auctions are valid, some may:

To retrieve active and valid auctions use dutch_auction_active

dutch_auction_active

Only the active and valid dutch auctions.

It is the recommended way of fetching active dutch auctions.

dutch_auction_sale

english_auction

English auctions are highest bid auctions.

WARNING Not all auctions are valid, some may:

To retrieve active and valid auctions use english_auction_active

english_auction_active

Only the active and valid english auctions.

It is the recommended way of fetching active english auctions.

english_auction_bid

event

Events are generated from blockchain actions

fa

A Tezos contract, represents either an FA2 contract or an FA1.2 contract (see type.)

Holds info about a collection and different stats.

fa2_attribute_count

Keeps track of attribute rarity per fa2.

Keeps track of attribute rarity per gallery.

holder

A holder is an implicit or originated tezos account.

invitation

An on-chain collaboration invitation

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:

To retrieve active and valid listings use listing_active

listing_active

Only the active and valid listings.

It is the recommended way of fetching active listings.

listing_sale

marketplace_contract

Contracts related to marketplace things (listings, offers, auctions, …)

We file MarketplaceContracts into groups and subgroups, and assign them an easily recognizable name.

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

offer_active

Only the active and valid offers.

It is the recommended way of fetching active offers.

open_edition

open_edition_active

Only the active and valid open editions.

It is the recommended way of fetching active open editions.

royalties

sales_stat

tag

An item from a tzip-21 tags array.

tezos_storage

token

token_attribute

token_creator

token_holder

token_operator

token_registry

token_tag

tzd_domain

Tezos Domains domains.

tzd_record

tzd_tld

Tezos Domains TLDs.