Documentação

Contratos para

DadosSem Autenticação

Obtenha os contratos disponíveis para um símbolo. Os parâmetros de pedido, os dados de mercado, os campos de apresentação e os campos Snowball foram removidos, e display_number_of_contracts pode ser null.

Comparação rápida

AspetoLegacy APINew APIAção
Endpointcontracts_forcontracts_forNenhum
Autenticação ObrigatóriaNãoNãoNenhum
Parâmetros de pedido8 parâmetros3 parâmetrosRemover parâmetros obsoletos
Estrutura de respostaDados de mercado e metadados de contratosApenas lista de contratosDeixe de ler campos removidos
display_number_of_contractsNúmeroNúmero ou nullTrate null

Alterações de rutura

1. Parâmetros de pedido removidos

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

Alteração necessária: Remova estes parâmetros dos seus pedidos de contracts_for .

2. Campos de dados de mercado removidos

O objeto contracts_for já não devolve spot, open, close, feed_license nem non_available.

Alteração necessária: Utilize ticks para preços spot e trading_times para horários de mercado.

3. Campos de apresentação removidos

Os contratos em available já não devolvem contract_display nem contract_category_display.

Alteração necessária: Crie nomes de apresentação a partir de contract_type e contract_category em vez disso.

4. Metadados de contratos removidos

Os contratos em available já não devolvem barrier_category, exchange_name, start_type, forward_starting_options nem trading_period. A API Legacy devolvia sempre barrier_category, contract_category_display, exchange_name e start_type.

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

5. Opções Snowball removidas

Os contratos em available já não devolvem duration_choices nem trade_risk_profile_choices, que descreviam contratos Snowball.

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

6. display_number_of_contracts pode ser null

display_number_of_contracts era sempre um número na Legacy API. Na New API, pode ser null.

Alteração necessária: Processe um valor null antes de o apresentar ou de efetuar cálculos com ele.

Estrutura de pedido

Legacy APIexemplo de pedido
{
  "contracts_for": "R_100",
  "currency": "USD",
  "landing_company": "svg",
  "product_type": "basic",
  "req_id": 1
}
New APIexemplo de pedido
{
  "contracts_for": "R_100",
  "req_id": 1
}

Estrutura de resposta

Legacy APIexemplo de resposta
{
  "contracts_for": {
    "available": [
      {
        "barriers": 0,
        "contract_category": "callput",
        "contract_type": "CALL",
        "expiry_type": "intraday",
        "market": "synthetic_index",
        "max_contract_duration": "1d",
        "min_contract_duration": "15s",
        "sentiment": "up",
        "submarket": "random_index",
        "underlying_symbol": "R_100",
        "barrier_category": "euro_atm",
        "contract_category_display": "Up/Down",
        "contract_display": "Higher",
        "exchange_name": "RANDOM",
        "start_type": "spot"
      }
    ],
    "close": 1760054399,
    "feed_license": "realtime",
    "hit_count": 1,
    "open": 1759968000,
    "spot": 1234.56
  },
  "echo_req": {
    "contracts_for": "R_100",
    "currency": "USD",
    "landing_company": "svg",
    "product_type": "basic",
    "req_id": 1
  },
  "msg_type": "contracts_for",
  "req_id": 1
}
New APIexemplo de resposta
{
  "contracts_for": {
    "available": [
      {
        "barriers": 0,
        "contract_category": "callput",
        "contract_type": "CALL",
        "expiry_type": "intraday",
        "market": "synthetic_index",
        "max_contract_duration": "1d",
        "min_contract_duration": "15s",
        "sentiment": "up",
        "submarket": "random_index",
        "underlying_symbol": "R_100"
      }
    ],
    "hit_count": 1
  },
  "echo_req": {
    "contracts_for": "R_100",
    "req_id": 1
  },
  "msg_type": "contracts_for",
  "req_id": 1
}

Exemplos de código

function getContracts(symbol) {
  ws.send(JSON.stringify({ contracts_for: symbol, currency: "USD", landing_company: "svg" }));

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

    console.log("Spot:", response.contracts_for.spot);
    response.contracts_for.available.forEach((contract) => {
      console.log(contract.contract_display, contract.exchange_name, contract.display_number_of_contracts);
    });
  };
}
Click to open live chat support. Get instant help from our support team.