Tezos · Schema

SelectionParameter

TezosBlockchainTzKTBaking BadCryptocurrencySmart ContractsNFTTokensDelegationsStakingGovernanceFA1.2FA2WebSocket

Properties

Name Type Description
fields array **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,balan
values array **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
View JSON Schema on GitHub

JSON Schema

selectionparameter.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SelectionParameter",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "fields": {
      "type": "array",
      "description": "**Fields** selection mode (optional, i.e. `select.fields=balance` is the same as `select=balance`). \\\nSpecify a comma-separated list of fields to include into response.\n\nExample:\n`?select=address,balance as b,metadata.name as meta_name` will result in\n`[ { \"address\": \"asd\", \"b\": 10, \"meta_name\": \"qwe\" } ]`.",
      "nullable": true,
      "items": {
        "type": "string"
      }
    },
    "values": {
      "type": "array",
      "description": "**Values** selection mode. \\\nSpecify a comma-separated list of fields to include their values into response.\n\nExample:\n`?select.values=address,balance,metadata.name`  will result in\n`[ [ \"asd\", 10, \"qwe\" ] ]`.",
      "nullable": true,
      "items": {
        "type": "string"
      }
    }
  },
  "x-tzkt-extension": "query-parameter"
}