Tezos · Schema

BigIntegerNullableParameter

TezosBlockchainTzKTBaking BadCryptocurrencySmart ContractsNFTTokensDelegationsStakingGovernanceFA1.2FA2WebSocket

Properties

Name	Type	Description
eq	string	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
ne	string	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`.
gt	string	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`.
ge	string	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`.
lt	string	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`.
le	string	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`.
in	array	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`.
ni	array	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`.
null	boolean	Is null filter mode. \ Use this mode to get items where the specified field is null or not. Example: `?nonce.null` or `?nonce.null=false`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BigIntegerNullableParameter",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "eq": {
      "type": "string",
      "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify an integer number to get items where the specified field is equal to the specified value.\n\nExample: `?balance=1234`.",
      "nullable": true
    },
    "ne": {
      "type": "string",
      "description": "**Not equal** filter mode. \\\nSpecify an integer number to get items where the specified field is not equal to the specified value.\n\nExample: `?balance.ne=1234`.",
      "nullable": true
    },
    "gt": {
      "type": "string",
      "description": "**Greater than** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than the specified value.\n\nExample: `?balance.gt=1234`.",
      "nullable": true
    },
    "ge": {
      "type": "string",
      "description": "**Greater or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than equal to the specified value.\n\nExample: `?balance.ge=1234`.",
      "nullable": true
    },
    "lt": {
      "type": "string",
      "description": "**Less than** filter mode. \\\nSpecify an integer number to get items where the specified field is less than the specified value.\n\nExample: `?balance.lt=1234`.",
      "nullable": true
    },
    "le": {
      "type": "string",
      "description": "**Less or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is less than or equal to the specified value.\n\nExample: `?balance.le=1234`.",
      "nullable": true
    },
    "in": {
      "type": "array",
      "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.\n\nExample: `?level.in=12,14,52,69`.",
      "nullable": true,
      "items": {
        "type": "string"
      }
    },
    "ni": {
      "type": "array",
      "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.\n\nExample: `?level.ni=12,14,52,69`.",
      "nullable": true,
      "items": {
        "type": "string"
      }
    },
    "null": {
      "type": "boolean",
      "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?nonce.null` or `?nonce.null=false`.",
      "nullable": true
    }
  },
  "x-tzkt-extension": "query-parameter"
}