Começar agora

Endpoints · Consultas salvas

Update a saved query

Esta referência está em inglês. A navegação e os rótulos estão traduzidos.

Renames, pins or replaces the query. Send only the fields you change.

PATCH/api/v1/saved-queries/{id}

Escopo: watchlists:write

Parâmetros

Parâmetros de caminho

  • idstringcaminhoobrigatório

    Saved query id, "sq_…".

Corpo

  • namestringcorpo

    New name.

  • queryInstrumentQuerycorpo

    Replaces the query.

  • pinnedbooleancorpo

    Pin or unpin.

Requisição
curl -X PATCH https://yieldsniper.finance/api/v1/saved-queries/sq_6adccafb1c9b331c1d1bbfcb \
  -H "Authorization: Bearer $YS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pinned": false
  }'
Resposta200
{
  "object": "saved_query",
  "id": "sq_6adccafb1c9b331c1d1bbfcb",
  "name": "Low-risk stables above 6.5%",
  "query": {
    "where": [
      {
        "field": "yield.total_apy",
        "op": "gte",
        "value": 6.5
      },
      {
        "field": "safety.band",
        "op": "eq",
        "value": "low"
      },
      {
        "field": "asset_class",
        "op": "eq",
        "value": "stablecoin"
      },
      {
        "field": "screen.verdict",
        "op": "eq",
        "value": "pass"
      }
    ],
    "match": "all",
    "sort": [
      {
        "field": "yield.total_apy",
        "direction": "desc"
      }
    ],
    "fields": [
      "name",
      "venue.protocol",
      "venue.chain",
      "yield.total_apy",
      "liquidity.tvl",
      "safety.score",
      "safety.band"
    ]
  },
  "pinned": false,
  "created_at": "2026-10-24T15:12:59.538Z",
  "updated_at": "2026-10-24T15:13:01.204Z"
}

Retorna

The updated saved query.

Objeto: Saved query