Empezar

Endpoints · Instrumentos

Query schema

Esta referencia está en inglés. La navegación y las etiquetas están traducidas.

Every field you can filter, sort and select on, with its type, operators, aliases and facet counts.

GET/api/v1/schema

Alcance: read

Parámetros

Use it to build a query interface or to validate a query before you send it.

Sin parámetros.

Solicitud
curl https://yieldsniper.finance/api/v1/schema \
  -H "Authorization: Bearer $YS_API_KEY"
Respuesta200
{
  "object": "schema",
  "version": "v1",
  "fields": [
    {
      "path": "yield.total_apy",
      "type": "percent",
      "ops": ["eq", "neq", "gt", "gte", "lt", "lte", "between", "in", "nin"],
      "group": "yield",
      "sortable": true,
      "nullable": false,
      "aliases": ["apy", "total_apy"]
    },
    {
      "path": "safety.band",
      "type": "enum",
      "ops": ["eq", "neq", "in", "nin"],
      "values": ["low", "moderate", "high"],
      "group": "safety",
      "sortable": true,
      "nullable": false,
      "aliases": ["band", "risk"]
    },
    …
  ],
  "facets": {
    "safety.band": [
      {
        "value": "moderate",
        "label": "Moderate risk",
        "count": 6599
      },
      {
        "value": "low",
        "label": "Low risk",
        "count": 4822
      },
      {
        "value": "high",
        "label": "High risk",
        "count": 4527
      }
    ],
    "venue.chain": [
      {
        "value": "ethereum",
        "label": "Ethereum",
        "count": 4536
      },
      {
        "value": "base",
        "label": "Base",
        "count": 3249
      },
      …
    ],
    …
  },
  "as_of": "2026-10-23T23:45:21.116Z",
  "limits": {
    "max_page_size": 100,
    "preview_rows": 5,
    "max_ids": 200,
    "max_saved_queries": 50,
    "max_watchlists": 50,
    "max_watchlist_instruments": 200
  },
  "access": "full"
}

Devuelve

A schema object.