Skip to main content

🦓 TzPro Tezos Identity API

The TzPro Identity API captures state and activity of major identity and metadata protocols on Tezos, currently including Tezos Domains and Tezos Profiles. Check current status and historic change events for every user wallet.

Supported Protocols

Tezos Domains

Support includes all features related to domain operations

  • domain names and subdomains
  • related FA2 token ids
  • expiry dates
  • forward and reverse address
  • domain metadata
  • domain to address resolution
  • address to domain reverse resolution

For market-related domain activity such as post-expiry auctions, regular domain sales, sale prices and price history use the NFT Market API.

Tezos Profiles

Support includes all Tezos Profiles features and claim types including claim revocation

  • Basic Profile (alias, description, logo, website)
  • Twitter Verification
  • Ethereum Address verification
  • Github Verification
  • Discord Verification
  • Domain Verification

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

Tezos Domains

Get info on Tezos Domain name records, subdomains, address pointers, expiry and metadata. Browse historic registration and change events.

List all domains

Returns a list of domains.

query Parameters
object

Filters by domain owner account.

object

Filters by domain name.

object

Filters by domain parent name (a level 2 domain name).

object

Filters by domain token id.

object

Filters by domain level.

object

Filters by domain forward address pointer.

object

Filters by domain reverse address pointer.

object

Filters by domain expiry time.

object

Filter by first block seen.

object

Filter by first time seen.

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
domain
string

Full qualified domain name.

entity
string
Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more

Custom entity label

expiry
string <date-time>

Domain registration expiry date. Subdomains (level > 2) inherit the parent's expiry.

first_block
integer <int64>

Block height where domain was created.

first_time
string <date-time>

Block timestamp where domain was created.

forward_address
string <address>

Address the domain points to. Can be used by wallets to resolve a domain name into an address. May be empty.

id
integer <int64>

Internal database id.

level
integer

Domain nesting level.

metadata
object

Optional user-defined metadata as key/value pairs.

owner
string <address>

Domain owner wallet.

reverse_address
string <address>

Domain name of a wallet. Can be used to name wallet addresses on frontends. May be empty of differ from forward address.

token_id
integer <int64>

FA2 token id of the domain (onlt relevant for level 2 domains).

Response samples

Content type
application/json
[
  • {
    }
]

List all domain events

Returns a list of domain events.

query Parameters
object

Filters by unique event database id.

object

Filter by event type.

object

Filters by domain owner account.

object

Filters by domain name.

object

Filters by domain parent name (a level 2 domain name).

object

Filters by domain token id.

object

Filters by domain level.

object

Filters by domain forward address pointer.

object

Filters by domain reverse address pointer.

object

Filter by transaction signer.

object

Filter by token sender.

address
string <address>

Filter by any address in signer, sender, forward and reverse record.

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.

domain
string

Full qualified domain name.

entity
string
Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more

Custom entity label

event_type
string
Enum: "set_expiry" "claim_domain" "update_domain" "transfer_domain" "claim_reverse_domain" … 1 more
expiry
string <date-time>

Domain registration expiry date. Subdomains (level > 2) inherit the parent's expiry.

forward_address
string <address>

Address the domain points to. Can be used by wallets to resolve a domain name into an address. May be empty.

id
integer <int64>

Internal database id.

level
integer

Domain nesting level.

metadata
object

Optional user-defined metadata as key/value pairs.

owner
string <address>

Domain owner wallet.

reverse_address
string <address>

Domain name of a wallet. Can be used to name wallet addresses on frontends. May be empty of differ from forward address.

sender
string <address>

Token sender address.

signer
string <address>

Transaction signer address.

time
string <date-time>

Block timestamp for the event.

token_id
integer <int64>

FA2 token id of the domain (onlt relevant for level 2 domains).

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
[
  • {
    }
]

Get domain by reverse address

Returns a domain the specified wallet or contract address points to.

path Parameters
address
required
string <address>

Domain name.

Responses

Response Schema: application/json
domain
string

Full qualified domain name.

entity
string
Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more

Custom entity label

expiry
string <date-time>

Domain registration expiry date. Subdomains (level > 2) inherit the parent's expiry.

first_block
integer <int64>

Block height where domain was created.

first_time
string <date-time>

Block timestamp where domain was created.

forward_address
string <address>

Address the domain points to. Can be used by wallets to resolve a domain name into an address. May be empty.

id
integer <int64>

Internal database id.

level
integer

Domain nesting level.

metadata
object

Optional user-defined metadata as key/value pairs.

owner
string <address>

Domain owner wallet.

reverse_address
string <address>

Domain name of a wallet. Can be used to name wallet addresses on frontends. May be empty of differ from forward address.

token_id
integer <int64>

FA2 token id of the domain (onlt relevant for level 2 domains).

Response samples

Content type
application/json
{
  • "domain": "domains.tez",
  • "entity": "tzdomains",
  • "expiry": "0001-01-01T00:00:00Z",
  • "first_block": 1417673,
  • "first_time": "2021-04-06T20:57:13Z",
  • "forward_address": "KT1Mqx5meQbhufngJnUAGEGpa4ZRxhPSiCgB",
  • "id": 2,
  • "level": 2,
  • "metadata": {
    },
  • "owner": "KT1Mqx5meQbhufngJnUAGEGpa4ZRxhPSiCgB",
  • "reverse_address": "",
  • "token_id": 1
}

Get domain by name

Returns a domain of specified name.

path Parameters
name
required
string

Domain name.

Responses

Response Schema: application/json
domain
string

Full qualified domain name.

entity
string
Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more

Custom entity label

expiry
string <date-time>

Domain registration expiry date. Subdomains (level > 2) inherit the parent's expiry.

first_block
integer <int64>

Block height where domain was created.

first_time
string <date-time>

Block timestamp where domain was created.

forward_address
string <address>

Address the domain points to. Can be used by wallets to resolve a domain name into an address. May be empty.

id
integer <int64>

Internal database id.

level
integer

Domain nesting level.

metadata
object

Optional user-defined metadata as key/value pairs.

owner
string <address>

Domain owner wallet.

reverse_address
string <address>

Domain name of a wallet. Can be used to name wallet addresses on frontends. May be empty of differ from forward address.

token_id
integer <int64>

FA2 token id of the domain (onlt relevant for level 2 domains).

Response samples

Content type
application/json
{
  • "domain": "domains.tez",
  • "entity": "tzdomains",
  • "expiry": "0001-01-01T00:00:00Z",
  • "first_block": 1417673,
  • "first_time": "2021-04-06T20:57:13Z",
  • "forward_address": "KT1Mqx5meQbhufngJnUAGEGpa4ZRxhPSiCgB",
  • "id": 2,
  • "level": 2,
  • "metadata": {
    },
  • "owner": "KT1Mqx5meQbhufngJnUAGEGpa4ZRxhPSiCgB",
  • "reverse_address": "",
  • "token_id": 1
}

List wallet events

Returns a list of domain events for a wallet.

path Parameters
address
required
string

Wallet address.

query Parameters
object

Filters by unique event database id.

object

Filter by event type.

object

Filters by domain owner account.

object

Filters by domain name.

object

Filters by domain parent name (a level 2 domain name).

object

Filters by domain token id.

object

Filters by domain level.

object

Filters by domain forward address pointer.

object

Filters by domain reverse address pointer.

object

Filter by transaction signer.

object

Filter by token 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
block
integer <int64>

Block height for the event.

domain
string

Full qualified domain name.

entity
string
Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more

Custom entity label

event_type
string
Enum: "set_expiry" "claim_domain" "update_domain" "transfer_domain" "claim_reverse_domain" … 1 more
expiry
string <date-time>

Domain registration expiry date. Subdomains (level > 2) inherit the parent's expiry.

forward_address
string <address>

Address the domain points to. Can be used by wallets to resolve a domain name into an address. May be empty.

id
integer <int64>

Internal database id.

level
integer

Domain nesting level.

metadata
object

Optional user-defined metadata as key/value pairs.

owner
string <address>

Domain owner wallet.

reverse_address
string <address>

Domain name of a wallet. Can be used to name wallet addresses on frontends. May be empty of differ from forward address.

sender
string <address>

Token sender address.

signer
string <address>

Transaction signer address.

time
string <date-time>

Block timestamp for the event.

token_id
integer <int64>

FA2 token id of the domain (onlt relevant for level 2 domains).

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
[
  • {
    }
]

List wallet domains

Returns a list of domains owned by wallet.

path Parameters
address
required
string

Wallet address.

query Parameters
object

Filters by domain name.

object

Filters by domain parent name (a level 2 domain name).

object

Filters by domain token id.

object

Filters by domain level.

object

Filters by domain forward address pointer.

object

Filters by domain reverse address pointer.

object

Filters by domain expiry time.

object

Filter by first block seen.

object

Filter by first time seen.

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
domain
string

Full qualified domain name.

entity
string
Enum: "quipu" "sirius" "plenty" "ctez" "dexter" … 77 more

Custom entity label

expiry
string <date-time>

Domain registration expiry date. Subdomains (level > 2) inherit the parent's expiry.

first_block
integer <int64>

Block height where domain was created.

first_time
string <date-time>

Block timestamp where domain was created.

forward_address
string <address>

Address the domain points to. Can be used by wallets to resolve a domain name into an address. May be empty.

id
integer <int64>

Internal database id.

level
integer

Domain nesting level.

metadata
object

Optional user-defined metadata as key/value pairs.

owner
string <address>

Domain owner wallet.

reverse_address
string <address>

Domain name of a wallet. Can be used to name wallet addresses on frontends. May be empty of differ from forward address.

token_id
integer <int64>

FA2 token id of the domain (onlt relevant for level 2 domains).

Response samples

Content type
application/json
[
  • {
    }
]

Tezos Profiles

Get info on Tezos Profiles like profile contents, claims and claim revocations.