Tezos · Schema

AddressNullParameter

TezosBlockchainTzKTBaking BadCryptocurrencySmart ContractsNFTTokensDelegationsStakingGovernanceFA1.2FA2WebSocket

Properties

Name Type Description
eq string **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=tz12
ne string **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 array **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..,tz
ni array **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=tz12
null boolean **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`.
View JSON Schema on GitHub

JSON Schema

addressnullparameter.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AddressNullParameter",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "eq": {
      "type": "string",
      "description": "**Equal** filter mode (optional, i.e. `param.eq=` is the same as `param=`). \\\nSpecify an account address to get items where the specified field is equal to the specified value.\n\nExample: `?address=tz123..`.",
      "nullable": true
    },
    "ne": {
      "type": "string",
      "description": "**Not equal** filter mode. \\\nSpecify an account address to get items where the specified field is not equal to the specified value.\n\nExample: `?address.ne=tz123..`.",
      "nullable": true
    },
    "in": {
      "type": "array",
      "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of account addresses to get items where the specified field is equal to one of the specified values.\n\nExample: `?address.in=tz123..,tz345..`.",
      "nullable": true,
      "items": {
        "type": "string",
        "nullable": true
      }
    },
    "ni": {
      "type": "array",
      "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of account addresses to get items where the specified field is not equal to all the specified values.\n\nExample: `?address.ni=tz123..,tz345..`.",
      "nullable": true,
      "items": {
        "type": "string",
        "nullable": true
      }
    },
    "null": {
      "type": "boolean",
      "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?address.null` or `?address.null=false`.",
      "nullable": true
    }
  },
  "x-tzkt-extension": "query-parameter"
}