objkt.com public API

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.

Upcoming changes

The following entities are now deprecated and will be removed in the future. A sunset date has not been defined yet but please stop using deprecated entities as soon as possible. Sign up to the mailing list to be notified about API changes.

v2 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_auction_sale

english_auction

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.

hen_swap

DEPRECATED in favor of listing

A HenSwap is a listing on a hicetnunc-like marketplace contract.

A swap is uniquely identified by swap_id, contract.

Supported contracts are:

hen_trade

DEPRECATED in favor of listing_sale

holder

A holder is an implicit or originated tezos account.

invitation

listing

A Listing is something listed for direct sale, for instance: "I am selling X editions of token Y for Z xtz each."

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.

obj_ask

DEPRECATED in favor of listing

An ask is a listing on objkt.com marketplace contract.

obj_dutch_auction

DEPRECATED in favor of dutch_auction

obj_english_auction

DEPRECATED in favor of english_auction

obj_english_bid

DEPRECATED in favor of english_auction_bid

obj_fulfilled_ask

DEPRECATED in favor of listing_sale

obj_fulfilled_dutch

DEPRECATED in favor of dutch_auction_sale

obj_offer

DEPRECATED in favor of offer

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."

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

tzd_record

tzd_tld