AIXBT Docs

Reference

Get the filter vocabularies

View as Markdown
GET
/v3/vocabulary

One discovery surface for every value a v3 filter accepts. Closed vocabularies (grades, sentiments, stances, sort keys, activity modes, rankings, universes, asset types, series measures) are versioned with the contract; catalog-derived sets (project categories, intel categories, chains) are composed from their owning catalogs at read time and carry their own versions.

Authorization

ApiKeyAuth
x-api-key<token>

API key. The Authorization header is accepted as an equivalent carrier. Responses echo the credential class in X-API-Key-Type.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v3/vocabulary"
{
  "data": {
    "grades": [
      "chipped",
      "flawed",
      "cut",
      "polished",
      "flawless"
    ],
    "sentiments": [
      "positive",
      "neutral",
      "negative"
    ],
    "stances": [
      "supportive",
      "skeptical",
      "neutral",
      "mixed",
      "unknown"
    ],
    "assetTypes": [
      "token",
      "stablecoin",
      "nft-collection"
    ],
    "marketCapBands": [
      "low",
      "mid",
      "large"
    ],
    "projectSort": [
      "rank",
      "trend",
      "createdAt",
      "reinforcedAt"
    ],
    "intelSort": [
      "reinforcedAt",
      "detectedAt"
    ],
    "activityModes": [
      "all",
      "observations",
      "none"
    ],
    "projectRankings": [
      "trend"
    ],
    "universes": [
      "crypto"
    ],
    "seriesMeasures": [
      "trend",
      "rank"
    ],
    "alertTriggers": [
      "intelligence.material",
      "rank.entered"
    ],
    "alertCadences": [
      "instant",
      "hourly",
      "every_12h",
      "daily"
    ],
    "projectCategories": [
      {
        "slug": "modular-blockchains",
        "name": "Modular blockchains"
      }
    ],
    "intelCategories": [
      {
        "slug": "product-launch",
        "name": "Product launch"
      }
    ],
    "chains": [
      "ethereum",
      "solana",
      "base"
    ]
  },
  "meta": {
    "versions": {
      "vocabulary": "3.0.0-draft.1",
      "taxonomy": "taxonomy-v2"
    }
  }
}

{
  "code": "credential_required",
  "message": "Provide an API key via the x-api-key header."
}

{
  "code": "rate_limited",
  "message": "Minute limit reached.",
  "details": {
    "limit": 100,
    "window": "minute"
  }
}
{
  "code": "internal_error",
  "message": "Unexpected error."
}