Tezos Domains API
The Domains API from Tezos — 3 operation(s) for domains.
The Domains API from Tezos — 3 operation(s) for domains.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/tezos-domains-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: TzKT Accounts Domains API
description: "# Introduction\n\nTzKT is the most widely used tool in Tezos that provides you with convenient and flexible access to the Tezos blockchain data, processed and indexed by its own indexer. \nYou can fetch all historical data via REST API, or subscribe for real-time data via WebSocket API. TzKT was built by the joint efforts of the entire Tezos community \nto help developers build more services and dapps on top of Tezos.\n\nTzKT Indexer and API are [open-source](https://github.com/baking-bad/tzkt), so don't be afraid to depend on the third-party service,\nbecause you can always clone, build and run it yourself to have full control over all the components.\n\nFeel free to contact us if you have any questions or feature requests.\nYour feedback is much appreciated!\n\n- Discord: https://discord.gg/aG8XKuwsQd\n- Telegram: https://t.me/baking_bad_chat\n- X: https://x.com/TezosBakingBad\n- Email: hello@bakingbad.dev\n\nAnd don't forget to star TzKT [on GitHub](https://github.com/baking-bad/tzkt) if you like it \U0001F60A\n\n# Get Started\n\nThere are two API services provided for public use:\n- **Free TzKT API** with free anonymous access;\n- **TzKT Pro** with paid subscriptions with increased rate limits, off-chain data, extended support and business-level SLA.\n\nYou can find more details about differences between available tiers [here](https://tzkt.io/api).\n\n## Free TzKT API\n\nFree-tier TzKT API is the best way to get started and explore available Tezos data and API functionality.\nIt doesn't require authorization and is free for everyone and for both commercial and non-commercial use.\n\n> #### Note: attribution required\nIf you use free-tier TzKT API, you **must** mention it on your website or application by placing the label\n\"Powered by TzKT API\", or \"Built with TzKT API\", or \"Data provided by TzKT API\" with a direct link to [tzkt.io](https://tzkt.io).\n\nIt's available for the following Tezos networks with the following base URLs:\n\n- Mainnet: `https://api.tzkt.io/` or `https://api.mainnet.tzkt.io/` ([view docs](https://api.tzkt.io))\n- Ghostnet: `https://api.ghostnet.tzkt.io/` ([view docs](https://api.ghostnet.tzkt.io))\n- Shadownet: `https://api.shadownet.tzkt.io/` ([view docs](https://api.shadownet.tzkt.io))\n- Seoulnet: `https://api.seoulnet.tzkt.io/` ([view docs](https://api.seoulnet.tzkt.io))\n- Tallinnnet: `https://api.tallinnnet.tzkt.io/` ([view docs](https://api.tallinnnet.tzkt.io))\n\n### Sending Requests\n\nTo send a request to Free TzKT API you need literally nothing. Just take the base URL of the particular network\n(for example, Tezos mainnet: `https://api.tzkt.io`) and append the path of the particular endpoint\n(for example, chain's head: `/v1/head`), that's pretty much it: \n\n```bash\ncurl https://api.tzkt.io/v1/head\n```\n\nRead through this documentation to explore available endpoints, query parameters\n(note, if you click on a query parameter, you will see available modes, such as `.eq`, `.in`, etc.)\nand response models. If you have any questions, do not hesitate to ask for support, Tezos community has always been very friendly! \U0001F609\n\n### Rate Limits\n\nPlease, refer to https://tzkt.io/api to check relevant rate limits.\n\nIf you exceed the limit, the API will respond with `HTTP 429` status code.\n\n## TzKT Pro\n\nTzKT Pro is intended for professional use, for those who seek for extended capabilities, performance, reliability and business-level SLA.\nTzKT Pro service is provided via paid subscriptions. Please, refer to [Pricing Plans](https://tzkt.io/api) to check available tiers.\n\nIt's available for the following Tezos networks with the following base URLs:\n\n- Mainnet: `https://pro.tzkt.io/` ([view docs](https://api.tzkt.io))\n- Testnets: *let us know if you need TzKT Pro for testnets*\n\n### Authorization\n\nTo access TzKT Pro you will need to authorize requests with your personal API key, that you will receive on your email after purchasing a subscription.\nThis can be done by adding the query string parameter `?apikey={your_key}` or by adding the HTTP header `apikey: {your_key}`.\n\nNote that you can have multiple API keys within a single subscription.\n\nKeep your API keys private, do not publish it anywhere and do not hardcode it, especially in public repositories.\nIf your key was compromised, just let us know and we will issue a new one.\n\nAlso note that passing the API key via HTTP headers is more secure, because in HTTPS headers are encrypted,\nbut query string is not, so the key can be unintentionally exposed to third parties.\n\n### Sending Requests\n\nSending a request with the API key passed as a query string parameter:\n\n```bash\ncurl https://pro.tzkt.io/v1/head?apikey={your_key}\n```\n\nSending a request with the API key passed via an HTTP header:\n\n```bash\ncurl https://pro.tzkt.io/v1/head \\\n -H 'apikey: {your_key}'\n```\n\n### Rate Limits\n\nPlease, refer to https://tzkt.io/api to check relevant rate limits for different pricing plans.\n\nAlso, TzKT Pro provides you with the additional HTTP headers to show the allowed limits, number of available requests\nand the time remaining (in seconds) until the quota is reset. Here's an example:\n\n```\nRateLimit-Limit: 50\nRateLimit-Remaining: 49\nRateLimit-Reset: 1\n```\n\nIt also sends general information about your rate limits per second and per day:\n\n```\nX-RateLimit-Limit-Second: 50\nX-RateLimit-Remaining-Second: 49\nX-RateLimit-Limit-Day: 3000000\nX-RateLimit-Remaining-Day: 2994953\n```\n\nIf you exceed the limit, the API will respond with `HTTP 429` status code.\n"
contact:
name: Baking Bad Team
url: https://bakingbad.dev
email: hello@bakingbad.dev
version: 1.17.1
x-logo:
url: https://tzkt.io/logo.png
href: https://tzkt.io/
servers:
- url: https://api.tzkt.io
tags:
- name: Domains
paths:
/v1/domains/count:
get:
tags:
- Domains
summary: Get domains count
description: Returns the total number of domains.
operationId: Domains_GetCount
parameters:
- name: id
in: query
description: "Filter by internal TzKT id. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 1
x-tzkt-extension: query-parameter
- name: level
in: query
description: "Filter by the domain level. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 2
x-tzkt-extension: query-parameter
- name: name
in: query
description: "Filter by the domain name. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/StringParameter'
x-position: 3
x-tzkt-extension: query-parameter
- name: owner
in: query
description: "Filter by the domain owner. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/AddressNullParameter'
x-position: 4
x-tzkt-extension: query-parameter
- name: address
in: query
description: "Filter by the address the domain points to. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/AddressNullParameter'
x-position: 5
x-tzkt-extension: query-parameter
- name: reverse
in: query
description: "Filter by the 'reverse' flag. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/BoolParameter'
x-position: 6
x-tzkt-extension: query-parameter
- name: expiration
in: query
description: "Filter by the domain expiration. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/DateTimeParameter'
x-position: 7
x-tzkt-extension: query-parameter
- name: data
in: query
description: "Filter by the domain data. \nNote, this parameter supports the following format: `data{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?data.foo=bar`). \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/JsonParameter'
x-position: 8
x-tzkt-extension: json-parameter
- name: firstLevel
in: query
description: "Filter by level of the block where the domain was first seen. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 9
x-tzkt-extension: query-parameter
- name: firstTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the domain was first seen. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 10
x-tzkt-extension: query-parameter
- name: lastLevel
in: query
description: "Filter by level of the block where the domain was last seen. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 11
x-tzkt-extension: query-parameter
- name: lastTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the domain was last seen. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 12
x-tzkt-extension: query-parameter
responses:
'200':
description: ''
content:
application/json:
schema:
type: integer
format: int32
/v1/domains:
get:
tags:
- Domains
summary: Get domains
description: Returns a list of domains.
operationId: Domains_Get
parameters:
- name: id
in: query
description: "Filter by internal TzKT id. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 1
x-tzkt-extension: query-parameter
- name: level
in: query
description: "Filter by the domain level. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 2
x-tzkt-extension: query-parameter
- name: name
in: query
description: "Filter by the domain name. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/StringParameter'
x-position: 3
x-tzkt-extension: query-parameter
- name: owner
in: query
description: "Filter by the domain owner. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/AddressNullParameter'
x-position: 4
x-tzkt-extension: query-parameter
- name: address
in: query
description: "Filter by the address the domain points to. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/AddressNullParameter'
x-position: 5
x-tzkt-extension: query-parameter
- name: reverse
in: query
description: "Filter by the 'reverse' flag. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/BoolParameter'
x-position: 6
x-tzkt-extension: query-parameter
- name: expiration
in: query
description: "Filter by the domain expiration. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/DateTimeParameter'
x-position: 7
x-tzkt-extension: query-parameter
- name: data
in: query
description: "Filter by the domain data. \nNote, this parameter supports the following format: `data{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?data.foo=bar`). \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/JsonParameter'
x-position: 8
x-tzkt-extension: json-parameter
- name: firstLevel
in: query
description: "Filter by level of the block where the domain was first seen. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 9
x-tzkt-extension: query-parameter
- name: firstTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the domain was first seen. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 10
x-tzkt-extension: query-parameter
- name: lastLevel
in: query
description: "Filter by level of the block where the domain was last seen. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 11
x-tzkt-extension: query-parameter
- name: lastTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the domain was last seen. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 12
x-tzkt-extension: query-parameter
- name: sort
in: query
description: "Sorts items (asc or desc) by the specified field.\nYou can see what fields can be used for sorting in the response description, below. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/SortParameter'
x-position: 13
x-tzkt-extension: query-parameter
- name: offset
in: query
description: "Specifies which or how many items should be skipped. \nClick on the parameter to expand more details."
schema:
oneOf:
- $ref: '#/components/schemas/OffsetParameter'
x-position: 14
x-tzkt-extension: query-parameter
- name: limit
in: query
description: Maximum number of items to return.
schema:
type: integer
format: int32
maximum: 10000.0
minimum: 0.0
x-position: 15
- name: select
in: query
description: "Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.\nThis parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection\n(for example, `?select=balance,token.metadata.symbol as token,...`). \nNote, if you select just one field, the response will be flatten into a simple array of values. \nClick on the parameter to expand the details."
schema:
oneOf:
- $ref: '#/components/schemas/SelectionParameter'
x-position: 16
x-tzkt-extension: query-parameter
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Domain'
/v1/domains/{name}:
get:
tags:
- Domains
summary: Get domain by name
description: Returns the domain with the specified name.
operationId: Domains_GetByName
parameters:
- name: name
in: path
required: true
description: Domain name
schema:
type: string
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
components:
schemas:
OffsetParameter:
type: object
additionalProperties: false
properties:
el:
type:
- integer
- 'null'
description: '**Elements** offset mode (optional, i.e. `offset.el=123` is the same as `offset=123`). \
Skips specified number of elements.
Example: `?offset=100`.'
format: int32
pg:
type:
- integer
- 'null'
description: '**Page** offset mode. \
Skips `page * limit` elements. This is a classic pagination.
Example: `?offset.pg=1`.'
format: int32
cr:
type:
- integer
- 'null'
description: '**Cursor** offset mode. \
Skips all elements with the `cursor` before (including) the specified value. Cursor is a field used for sorting, e.g. `id`.
Avoid using this offset mode with non-unique or non-sequential cursors such as `amount`, `balance`, etc.
Example: `?offset.cr=45837`.'
format: int64
x-tzkt-extension: query-parameter
DateTimeParameter:
type: object
additionalProperties: false
properties:
eq:
type:
- string
- 'null'
description: '**Equal** filter mode (optional, i.e. `param.eq=2020-01-01` is the same as `param=2020-01-01`). \
Specify a datetime to get items where the specified field is equal to the specified value.
Example: `?timestamp=2020-02-20T02:40:57Z`.'
format: date-time
ne:
type:
- string
- 'null'
description: '**Not equal** filter mode. \
Specify a datetime to get items where the specified field is not equal to the specified value.
Example: `?timestamp.ne=2020-02-20T02:40:57Z`.'
format: date-time
gt:
type:
- string
- 'null'
description: '**Greater than** filter mode. \
Specify a datetime to get items where the specified field is greater than the specified value.
Example: `?timestamp.gt=2020-02-20T02:40:57Z`.'
format: date-time
ge:
type:
- string
- 'null'
description: '**Greater or equal** filter mode. \
Specify a datetime to get items where the specified field is greater than equal to the specified value.
Example: `?timestamp.ge=2020-02-20T02:40:57Z`.'
format: date-time
lt:
type:
- string
- 'null'
description: '**Less than** filter mode. \
Specify a datetime to get items where the specified field is less than the specified value.
Example: `?timestamp.lt=2020-02-20T02:40:57Z`.'
format: date-time
le:
type:
- string
- 'null'
description: '**Less or equal** filter mode. \
Specify a datetime to get items where the specified field is less than or equal to the specified value.
Example: `?timestamp.le=2020-02-20T02:40:57Z`.'
format: date-time
in:
type:
- array
- 'null'
description: '**In list** (any of) filter mode. \
Specify a comma-separated list of datetimes to get items where the specified field is equal to one of the specified values.
Example: `?timestamp.in=2020-02-20,2020-02-21`.'
items:
type: string
format: date-time
ni:
type:
- array
- 'null'
description: '**Not in list** (none of) filter mode. \
Specify a comma-separated list of datetimes to get items where the specified field is not equal to all the specified values.
Example: `?timestamp.ni=2020-02-20,2020-02-21`.'
items:
type: string
format: date-time
x-tzkt-extension: query-parameter
SortParameter:
type: object
additionalProperties: false
properties:
asc:
type:
- string
- 'null'
description: '**Ascending** sort mode (optional, i.e. `sort.asc=id` is the same as `sort=id`). \
Specify a field name to sort by.
Example: `?sort=balance`.'
desc:
type:
- string
- 'null'
description: '**Descending** sort mode. \
Specify a field name to sort by descending.
Example: `?sort.desc=id`.'
x-tzkt-extension: query-parameter
SelectionParameter:
type: object
additionalProperties: false
properties:
fields:
type:
- array
- 'null'
description: '**Fields** selection mode (optional, i.e. `select.fields=balance` is the same as `select=balance`). \
Specify a comma-separated list of fields to include into response.
Example:
`?select=address,balance as b,metadata.name as meta_name` will result in
`[ { "address": "asd", "b": 10, "meta_name": "qwe" } ]`.'
items:
type: string
values:
type:
- array
- 'null'
description: '**Values** selection mode. \
Specify a comma-separated list of fields to include their values into response.
Example:
`?select.values=address,balance,metadata.name` will result in
`[ [ "asd", 10, "qwe" ] ]`.'
items:
type: string
x-tzkt-extension: query-parameter
TimestampParameter:
type: object
additionalProperties: false
properties:
eq:
type:
- string
- 'null'
description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \
Specify a datetime value to get items where the specified field is equal to the specified value.
Example: `?timestamp=2020-02-20T02:40:57Z`.'
format: date-time
ne:
type:
- string
- 'null'
description: '**Not equal** filter mode. \
Specify a datetime value to get items where the specified field is not equal to the specified value.
Example: `?timestamp.ne=2020-02-20T02:40:57Z`.'
format: date-time
gt:
type:
- string
- 'null'
description: '**Greater than** filter mode. \
Specify a datetime value to get items where the specified field is greater than the specified value.
Example: `?timestamp.gt=2020-02-20T02:40:57Z`.'
format: date-time
ge:
type:
- string
- 'null'
description: '**Greater or equal** filter mode. \
Specify a datetime value to get items where the specified field is greater than equal to the specified value.
Example: `?timestamp.ge=2020-02-20T02:40:57Z`.'
format: date-time
lt:
type:
- string
- 'null'
description: '**Less than** filter mode. \
Specify a datetime value to get items where the specified field is less than the specified value.
Example: `?timestamp.lt=2020-02-20T02:40:57Z`.'
format: date-time
le:
type:
- string
- 'null'
description: '**Less or equal** filter mode. \
Specify a datetime value to get items where the specified field is less than or equal to the specified value.
Example: `?timestamp.le=2020-02-20T02:40:57Z`.'
format: date-time
in:
type:
- array
- 'null'
description: '**In list** (any of) filter mode. \
Specify a comma-separated list of datetimes to get items where the specified field is equal to one of the specified values.
Example: `?timestamp.in=2020-02-20,2020-02-21`.'
items:
type: string
format: date-time
ni:
type:
- array
- 'null'
description: '**Not in list** (none of) filter mode. \
Specify a comma-separated list of datetimes to get items where the specified field is not equal to all the specified values.
Example: `?timestamp.ni=2020-02-20,2020-02-21`.'
items:
type: string
format: date-time
x-tzkt-extension: query-parameter
BoolParameter:
type: object
additionalProperties: false
properties:
eq:
type:
- boolean
- 'null'
description: '**Equal** filter mode (optional, i.e. `param.eq=true` is the same as `param=true`). \
Specify a bool flag to get items where the specified field is equal to the specified value.
Example: `?active=true` or `?active=1` or `?active`.'
'null':
type:
- boolean
- 'null'
description: '**Is null** filter mode. \
Use this mode to get items where the specified field is null or not.
Example: `?active.null` or `?active.null=false`.'
x-tzkt-extension: query-parameter
Int32Parameter:
type: object
additionalProperties: false
properties:
eq:
type:
- integer
- 'null'
description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \
Specify an integer number to get items where the specified field is equal to the specified value.
Example: `?balance=1234`.'
format: int32
ne:
type:
- integer
- 'null'
description: '**Not equal** filter mode. \
Specify an integer number to get items where the specified field is not equal to the specified value.
Example: `?balance.ne=1234`.'
format: int32
gt:
type:
- integer
- 'null'
description: '**Greater than** filter mode. \
Specify an integer number to get items where the specified field is greater than the specified value.
Example: `?balance.gt=1234`.'
format: int32
ge:
type:
- integer
- 'null'
description: '**Greater or equal** filter mode. \
Specify an integer number to get items where the specified field is greater than equal to the specified value.
Example: `?balance.ge=1234`.'
format: int32
lt:
type:
- integer
- 'null'
description: '**Less than** filter mode. \
Specify an integer number to get items where the specified field is less than the specified value.
Example: `?balance.lt=1234`.'
format: int32
le:
type:
- integer
- 'null'
description: '**Less or equal** filter mode. \
Specify an integer number to get items where the specified field is less than or equal to the specified value.
Example: `?balance.le=1234`.'
format: int32
in:
type:
- array
- 'null'
description: '**In list** (any of) filter mode. \
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.
Example: `?level.in=12,14,52,69`.'
items:
type: integer
format: int32
ni:
type:
- array
- 'null'
description: '**Not in list** (none of) filter mode. \
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.
Example: `?level.ni=12,14,52,69`.'
items:
type: integer
format: int32
x-tzkt-extension: query-parameter
AddressNullParameter:
type: object
additionalProperties: false
properties:
eq:
type:
- string
- 'null'
description: '**Equal** filter mode (optional, i.e. `param.eq=` is the same as `param=`). \
Specify an account address to get items where the specified field is equal to the specified value.
Example: `?address=tz123..`.'
ne:
type:
- string
- 'null'
description: '**Not equal** filter mode. \
Specify an account address to get items where the specified field is not equal to the specified value.
Example: `?address.ne=tz123..`.'
in:
type:
- array
- 'null'
description: '**In list** (any of) filter mode. \
Specify a comma-separated list of account addresses to get items where the specified field is equal to one of the specified values.
Example: `?address.in=tz123..,tz345..`.'
items:
type:
- string
- 'null'
ni:
type:
- array
- 'null'
description: '**Not in list** (none of) filter mode. \
Specify a comma-separated list of account addresses to get items where the specified field is not equal to all the specified values.
Example: `?address.ni=tz123..,tz345..`.'
items:
type:
- string
- 'null'
'null':
type:
- boolean
- 'null'
description: '**Is null** filter mode. \
Use this mode to get items where the specified field is null or not.
Example: `?address.null` or `?address.null=false`.'
x-tzkt-extension: query-parameter
JsonParameter:
type: object
additionalProperties: false
properties:
eq:
type:
- string
- 'null'
description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \
Specify a JSON value to get items where the specified field is equal to the specified value.
Example: `?parameter.from=tz1...` or `?parameter.signatures.[3].[0]=null` or `?parameter.sigs.[*]=null`.'
x-tzkt-extension: json-parameter
ne:
type:
- string
- 'null'
description: '**Not equal** filter mode. \
Specify a JSON value to get items where the specified field is not equal to the specified value.
Example: `?parameter.ne=true` or `?parameter.amount.ne=0`.'
x-tzkt-extension: json-parameter
gt:
type:
- string
- 'null'
description: '**Greater than** filter mode. \
Specify a string to get items where the specified field is greater than the specified value.
Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type,
e.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc.
Otherwise, result may surprise you.
Example: `?parameter.balance.gt=1234` or `?parameter.time.gt=2021-02-01`.'
x-tzkt-extension: json-parameter
ge:
type:
- string
- 'null'
description: '**Greater or equal** filter mode. \
Specify a string to get items where the specified field is greater than equal to the specified value.
Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type,
e.g. numeric strings with numeric strings
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tezos/refs/heads/main/openapi/tezos-domains-api-openapi.yml