Developers
AccediInizia a costruire
Non pubblicato — questa pagina è visibile solo in staging e non è sul sito pubblico.
Vedi .mdENIT

Descrivi un filtro dello screener

POST/api/v1/research/describe_screen_filter

Restituisce un filtro dello screener per intero: che cosa misura, gli input che accetta (come quanti mesi o bilanci prima viene letto il suo valore), ogni relazione che supporta (maggiore di, tra, i primi N, rispetto all’aggregato di mercato o di settore, rispetto al proprio passato), i termini di confronto di ciascuna relazione con i valori ammessi e quelli predefiniti, e l’unità di ogni valore.

Autenticazione
REST: una chiave API o un token di accesso OAuth. MCP: un token di accesso OAuth.
Strumento MCP
describe_screen_filter
Costo
una chiamata di ricerca

Parametri

Quali parametri accetta Descrivi un filtro dello screener?

  • idtestoObbligatorio

    L’id pubblico del filtro, come lo restituisce list_screen_filters.

Risposta

Che cosa restituisce Descrivi un filtro dello screener?

  • filteroggetto

    Il filtro per intero.

    Mostra i 10 campi
    • idtesto

      L’id pubblico e stabile del filtro.

    • nametesto

      almeno 1 caratteri

      Il nome del filtro come lo mostra lo screener.

    • leveltesto

      uno tra asset, sector, market

      asset, sector o market.

    • categorytesto

      uno tra fundamental, technical, options, short_selling, ownership, market_and_sector

      fundamental, technical, options, short_selling, ownership o market_and_sector.

    • subcategorytesto

      almeno 1 caratteri · può essere null

      La sottocategoria del catalogo, come Valuation Ratios; null quando il catalogo non ne indica una.

    • descriptiontesto

      almeno 1 caratteri · può essere null

      La descrizione del catalogo di che cosa misura il filtro; null quando il catalogo non ne dà una.

    • appliesToelenco

      I tipi di asset a cui il filtro si applica.

    • inputselenco

      Le impostazioni che il filtro richiede prima del confronto, come quanti mesi o bilanci prima viene letto il suo valore.

      Mostra i 6 campi
      • idtesto

        uno tra months_ago, reports_ago, months, days, quarters, bars, std_devs

        months_ago, reports_ago, months, days, quarters, bars o std_devs.

      • nametesto

        almeno 1 caratteri

        Il nome dell’input come lo mostra lo screener.

      • descriptiontesto

        almeno 1 caratteri

        Che cosa cambia l’input e l’unità in cui è contato.

      • unittesto

        uno tra none, number, count, days, weeks, months, quarters, years, reports, bars, fraction, percent, multiple, sharpe_points, sigma, usd, base_currency, date, native

        L’unità dei valori dell’input. Convenzione: native_unit

      • valuesoggetto

        I valori che l’input accetta.

        Mostra i 5 campi
        • kindtesto

          uno tra range

          range per valori equidistanti da min a max, list per un elenco esplicito.

        • minnumero

          unità: l’unità di ciò che descrive

          Il valore più piccolo di un intervallo. Convenzione: native_unit

        • maxnumero

          unità: l’unità di ciò che descrive

          Il valore più grande di un intervallo. Convenzione: native_unit

        • stepnumero

          maggiore di 0 · unità: l’unità di ciò che descrive

          La distanza tra i valori di un intervallo. Convenzione: native_unit

        • valueselenco

          unità: l’unità di ciò che descrive

          I valori accettati di un elenco. Convenzione: native_unit

      • defaultnumero

        unità: l’unità di ciò che descrive

        Il valore che lo screener propone. Convenzione: native_unit

    • relationselenco

      Ogni relazione che il filtro supporta, ciascuna con ciò a cui può essere confrontata.

      Mostra i 3 campi
      • idtesto

        uno tra greater_than, less_than, greater_or_equal, less_or_equal, between, highest, lowest, equal, price_above, price_below, crossing_above_within_days, crossing_below_within_days, strongly_overvalued, overvalued, in_range, undervalued, strongly_undervalued, fast_bull_crossover_within_days, fast_bear_crossover_within_days, slow_bull_crossover_within_days, slow_bear_crossover_within_days, fast_over_slow_bull_crossover_within_days, fast_over_slow_bear_crossover_within_days

        L’id pubblico della relazione, come greater_than, between, highest, crossing_above_within_days o undervalued.

      • labeltesto

        almeno 1 caratteri

        L’etichetta della relazione nello screener, come > o Between.

      • targetselenco

        A che cosa può essere confrontato il valore del filtro con questa relazione.

        Mostra i 5 campi
        • kindtesto

          uno tra value

          value (un valore fisso), range (due valori), count (l’N di highest o lowest N), market_aggregate o sector_aggregate (una statistica del mercato o del settore), own_past (il valore precedente del filtro stesso) oppure none (la relazione non richiede un valore).

        • unittesto

          uno tra none, number, count, days, weeks, months, quarters, years, reports, bars, fraction, percent, multiple, sharpe_points, sigma, usd, base_currency, date, native

          L’unità dei valori del termine di confronto: number per un numero semplice, fraction per una percentuale (0.02 è il 2.0 % che mostra lo screener), usd per i dollari statunitensi. Convenzione: fraction

        • valuesoggetto

          I valori che il termine di confronto accetta.

          Mostra i 5 campi
          • kindtesto

            uno tra range

            range o list, come per gli input.

          • minnumero

            unità: l’unità di ciò che descrive

            Il valore più piccolo di un intervallo. Convenzione: native_unit

          • maxnumero

            unità: l’unità di ciò che descrive

            Il valore più grande di un intervallo. Convenzione: native_unit

          • stepnumero

            maggiore di 0 · unità: l’unità di ciò che descrive

            La distanza tra i valori di un intervallo. Convenzione: native_unit

          • valueselenco

            unità: l’unità di ciò che descrive

            I valori accettati di un elenco. Convenzione: native_unit

        • defaultnumero

          unità: l’unità di ciò che descrive

          Ciò che lo screener propone: un numero per value, una coppia per range, un conteggio per count, una statistica per un aggregato. Convenzione: native_unit

        • statisticselenco

          Le statistiche che un aggregato può usare: average, median, p75, p25 e index dove l’aggregato è il livello di un indice.

    • defaultRelationtesto

      uno tra greater_than, less_than, greater_or_equal, less_or_equal, between, highest, lowest, equal, price_above, price_below, crossing_above_within_days, crossing_below_within_days, strongly_overvalued, overvalued, in_range, undervalued, strongly_undervalued, fast_bull_crossover_within_days, fast_bear_crossover_within_days, slow_bull_crossover_within_days, slow_bear_crossover_within_days, fast_over_slow_bull_crossover_within_days, fast_over_slow_bear_crossover_within_days · può essere null

      La relazione che lo screener propone per prima; null quando il catalogo non ne propone una, e allora ogni riga del filtro indica la sua relazione.

Ogni risposta arriva dentro la struttura del risultato comune a tutte le operazioni.

Errori

Quali codici di errore restituisce Descrivi un filtro dello screener?

  • not_found HTTP 404

    Nessun filtro ha l’id che hai indicato. Cerca con list_screen_filters e usa un id che restituisce.

  • engine_failed HTTP 502

    Fincanva non è riuscito a leggere dal suo motore il catalogo dei filtri dello screener, e non ne aveva uno da prima. Riprova tra un minuto.

Comuni a tutte le operazioni

  • unauthorized HTTP 401
  • plan_limit HTTP 403
  • invalid_input HTTP 422
  • quota_exhausted HTTP 429
  • rate_limited HTTP 429

Tutti i codici di errore

Quando si usa Descrivi un filtro dello screener?

  • Stai scrivendo una riga di screener e ti servono i valori esatti che un filtro accetta.
  • L’utente chiede come si può confrontare un filtro, o qual è la sua soglia predefinita.
  • Non conosci ancora l’id del filtro — Usa invece list_screen_filters
  • Hai scelto i filtri e vuoi che lo screener venga costruito — Usa invece create_screener

Com’è fatta una chiamata a Descrivi un filtro dello screener?

Tutti i modi in cui si può confrontare il filtro P/E

Quali soglie di P/E può usare una riga dello screener?

P/E: an asset-level fundamental filter for stocks, with 1 input and 7 relations; the screener proposes between 0 and 15.
Risposta completa · 200
{
  "status": true,
  "data": {
    "result": {
      "filter": {
        "id": "p_e",
        "name": "P/E",
        "level": "asset",
        "category": "fundamental",
        "subcategory": "Valuation Ratios",
        "description": "The Price to Earnings ratio indicates the dollar amount an investor can expect to invest in a company in order to receive $1 of that company’s earnings.",
        "appliesTo": [
          "stocks"
        ],
        "inputs": [
          {
            "id": "months_ago",
            "name": "Months Ago",
            "description": "Lag allows you to reference a value from the past.",
            "unit": "months",
            "values": {
              "kind": "list",
              "values": [
                0,
                1,
                2,
                3,
                6,
                12,
                24
              ]
            },
            "default": 0
          }
        ],
        "relations": [
          {
            "id": "greater_than",
            "label": ">",
            "targets": [
              {
                "kind": "value",
                "unit": "number",
                "values": {
                  "kind": "range",
                  "min": -20,
                  "max": 100,
                  "step": 0.5
                },
                "default": 12
              },
              {
                "kind": "market_aggregate",
                "statistics": [
                  "average",
                  "median",
                  "p75",
                  "p25"
                ],
                "default": "average"
              },
              {
                "kind": "sector_aggregate",
                "statistics": [
                  "average",
                  "median",
                  "p75",
                  "p25"
                ],
                "default": "average"
              },
              {
                "kind": "own_past"
              }
            ]
          },
          {
            "id": "less_than",
            "label": "<",
            "targets": [
              {
                "kind": "value",
                "unit": "number",
                "values": {
                  "kind": "range",
                  "min": -20,
                  "max": 100,
                  "step": 0.5
                },
                "default": 12
              },
              {
                "kind": "market_aggregate",
                "statistics": [
                  "average",
                  "median",
                  "p75",
                  "p25"
                ],
                "default": "average"
              },
              {
                "kind": "sector_aggregate",
                "statistics": [
                  "average",
                  "median",
                  "p75",
                  "p25"
                ],
                "default": "average"
              },
              {
                "kind": "own_past"
              }
            ]
          },
          {
            "id": "greater_or_equal",
            "label": ">=",
            "targets": [
              {
                "kind": "value",
                "unit": "number",
                "values": {
                  "kind": "range",
                  "min": -20,
                  "max": 100,
                  "step": 0.5
                },
                "default": 12
              },
              {
                "kind": "market_aggregate",
                "statistics": [
                  "average",
                  "median",
                  "p75",
                  "p25"
                ],
                "default": "average"
              },
              {
                "kind": "sector_aggregate",
                "statistics": [
                  "average",
                  "median",
                  "p75",
                  "p25"
                ],
                "default": "average"
              },
              {
                "kind": "own_past"
              }
            ]
          },
          {
            "id": "less_or_equal",
            "label": "<=",
            "targets": [
              {
                "kind": "value",
                "unit": "number",
                "values": {
                  "kind": "range",
                  "min": -20,
                  "max": 100,
                  "step": 0.5
                },
                "default": 12
              },
              {
                "kind": "market_aggregate",
                "statistics": [
                  "average",
                  "median",
                  "p75",
                  "p25"
                ],
                "default": "average"
              },
              {
                "kind": "sector_aggregate",
                "statistics": [
                  "average",
                  "median",
                  "p75",
                  "p25"
                ],
                "default": "average"
              },
              {
                "kind": "own_past"
              }
            ]
          },
          {
            "id": "between",
            "label": "Between",
            "targets": [
              {
                "kind": "range",
                "unit": "number",
                "values": {
                  "kind": "range",
                  "min": -20,
                  "max": 100,
                  "step": 0.5
                },
                "default": [
                  0,
                  15
                ]
              }
            ]
          },
          {
            "id": "highest",
            "label": "Highest",
            "targets": [
              {
                "kind": "count",
                "values": {
                  "kind": "list",
                  "values": [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9,
                    10,
                    11,
                    12,
                    13,
                    14,
                    15,
                    20,
                    25,
                    30,
                    35,
                    40,
                    50,
                    60,
                    70,
                    80,
                    90,
                    100,
                    120,
                    140,
                    160,
                    180,
                    200,
                    250,
                    300
                  ]
                },
                "default": 5
              }
            ]
          },
          {
            "id": "lowest",
            "label": "Lowest",
            "targets": [
              {
                "kind": "count",
                "values": {
                  "kind": "list",
                  "values": [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9,
                    10,
                    11,
                    12,
                    13,
                    14,
                    15,
                    20,
                    25,
                    30,
                    35,
                    40,
                    50,
                    60,
                    70,
                    80,
                    90,
                    100,
                    120,
                    140,
                    160,
                    180,
                    200,
                    250,
                    300
                  ]
                },
                "default": 5
              }
            ]
          }
        ],
        "defaultRelation": "between"
      }
    },
    "summary": "P/E: an asset-level fundamental filter for stocks, with 1 input and 7 relations; the screener proposes between 0 and 15.",
    "assumed": [],
    "dataVersion": null
  }
}

Dove si sbaglia più spesso con Descrivi un filtro dello screener?

  • I valori sono nell’unità che ogni termine di confronto indica — un numero semplice per il P/E, una frazione per una percentuale (0.02 è il 2 %), dollari statunitensi per la capitalizzazione di mercato. Un valore tra due di quelli elencati viene rifiutato, mai arrotondato.
  • highest e lowest richiedono un conteggio, non una soglia: highest 5 tiene i cinque valori più alti tra quelli che le righe precedenti hanno lasciato passare.
  • Un valore è letto alla data che l’input indica: months_ago 12 confronta il valore di un anno fa, non quello di oggi.

Quali piani includono Descrivi un filtro dello screener?

Famiglia: Screening · Costo in quota: una chiamata di ricerca — Disponibilità

Fincanva ha uno scopo solo educativo e illustrativo: non è una consulenza finanziaria personalizzata, e i risultati passati o simulati non indicano quelli futuri. Leggi l'Addendum ai Termini

DOCS · EN — IT