Documentação

Símbolos ativos

DadosSem Autenticação

Obtenha a lista de símbolos ativos, os mercados subjacentes nos quais pode negociar contratos. Os campos de resposta foram renomeados, os campos spot e de apresentação foram removidos, os parâmetros de filtragem foram removidos e os valores de contract_type foram alterados.

Comparação rápida

AspetoLegacy APINew APIAção
Endpointactive_symbolsactive_symbolsNenhum
Autenticação ObrigatóriaNãoNãoNenhum
Parâmetros de pedido9 parâmetros4 parâmetrosRemover parâmetros obsoletos
Campos do símbolosymbol, symbol_type, display_name, pipunderlying_symbol, underlying_symbol_type, underlying_symbol_name, pip_sizeRenomeie no seu código
Campos spotDevolvidoRemovidoUtilize ticks para preços spot
contract_type valoresInclui spreads e lookbacksAdiciona HIGHER e LOWERAtualize os seus filtros

Alterações de rutura

1. Campos de resposta renomeados

Quatro campos de cada símbolo foram renomeados:

  • symbol → underlying_symbol
  • symbol_type → underlying_symbol_type
  • display_name → underlying_symbol_name
  • pip → pip_size

Alteração obrigatória: Leia os novos nomes dos campos. O nome de apresentação do símbolo continua a ser devolvido como underlying_symbol_name.

2. Campos de nome de visualização traduzido removidos

market_display_name, subgroup_display_name e submarket_display_name já não são devolvidos.

Alteração necessária: Crie nomes de apresentação a partir de market, subgroup e submarket em alternativa.

3. Campos spot removidos

spot, spot_age, spot_percentage_change e spot_time deixaram de ser devolvidos.

Alteração necessária: Utilize a chamada ticks para obter preços spot em tempo real.

4. Empresa de referência contratual, tipo de produto e parâmetros loginid removidos

O pedido já não aceita landing_company, landing_company_short, product_type nem loginid.

Alteração obrigatória: Remova estes parâmetros dos seus pedidos active_symbols .

5. barrier_category removido

O pedido já não aceita barrier_category, pelo que já não pode filtrar símbolos por categoria de barreira.

Alteração obrigatória: Remova barrier_category e filtre a lista de símbolos no seu código, ou filtre por contract_type.

6. Campos de metadados removidos

allow_forward_starting, close_only, delay_amount, display_order, exchange_name, intraday_interval_minutes e quoted_currency_symbol já não são devolvidos.

Alteração necessária: Deixe de ler estes campos.

7. contract_type valores alterados

O filtro contract_type já não aceita CALLSPREAD, PUTSPREAD, LBFLOATCALL, LBFLOATPUT nem LBHIGHLOW, e adiciona HIGHER e LOWER.

Alteração necessária: Remova de contract_typeos valores que a New API já não aceita.

Estrutura de pedido

Legacy APIexemplo de pedido
{
  "active_symbols": "brief",
  "contract_type": [
    "CALL",
    "CALLSPREAD"
  ],
  "landing_company": "svg",
  "req_id": 1
}
New APIexemplo de pedido
{
  "active_symbols": "brief",
  "contract_type": [
    "CALL",
    "HIGHER"
  ],
  "req_id": 1
}

Estrutura de resposta

Legacy APIexemplo de resposta
{
  "active_symbols": [
    {
      "display_name": "Volatility 100 Index",
      "display_order": 1,
      "exchange_is_open": 1,
      "is_trading_suspended": 0,
      "market": "synthetic_index",
      "market_display_name": "Derived",
      "pip": 0.01,
      "subgroup": "synthetics",
      "subgroup_display_name": "Synthetics",
      "submarket": "random_index",
      "submarket_display_name": "Continuous Indices",
      "symbol": "R_100",
      "symbol_type": "stockindex"
    }
  ],
  "echo_req": {
    "active_symbols": "brief",
    "contract_type": [
      "CALL",
      "CALLSPREAD"
    ],
    "landing_company": "svg",
    "req_id": 1
  },
  "msg_type": "active_symbols",
  "req_id": 1
}
New APIexemplo de resposta
{
  "active_symbols": [
    {
      "exchange_is_open": 1,
      "is_trading_suspended": 0,
      "market": "synthetic_index",
      "pip_size": 0.01,
      "subgroup": "synthetics",
      "submarket": "random_index",
      "trade_count": 1250,
      "underlying_symbol": "R_100",
      "underlying_symbol_name": "Volatility 100 Index",
      "underlying_symbol_type": "stockindex"
    }
  ],
  "echo_req": {
    "active_symbols": "brief",
    "contract_type": [
      "CALL",
      "HIGHER"
    ],
    "req_id": 1
  },
  "msg_type": "active_symbols",
  "req_id": 1
}

Exemplos de código

function getActiveSymbols() {
  ws.send(JSON.stringify({ active_symbols: "brief", landing_company: "svg" }));

  ws.onmessage = (event) => {
    const response = JSON.parse(event.data);
    if (response.msg_type !== "active_symbols" || !response.active_symbols) return;

    response.active_symbols.forEach((symbol) => {
      console.log(symbol.symbol, symbol.display_name, symbol.market_display_name, symbol.pip);
    });
  };
}
Click to open live chat support. Get instant help from our support team.