Documentation

Proposal open contract

TradingAuth Required

Get open contract details. The loginid parameter removed, response field types changed, and several display fields removed.

Quick comparison

AspectLegacy APINew APIAction
Endpointproposal_open_contractproposal_open_contractNone
loginid ParameterOptionalRemovedRemove from requests
Response Required Fieldsecho_req onlycontract_id, contract_type, currencyUpdate type expectations

Breaking changes

1. loginid parameter removed

The loginid parameter has been removed from the request schema.

2. Response field types changed

Several numeric fields now return string | number instead of just number:

  • bid_price, buy_price, current_spot, profit: string | number
  • payout: string (always string now)

3. Required fields in response

The proposal_open_contract response object now has required fields: contract_id, contract_type, and currency.

4. Display fields removed

Several display-specific fields have been removed: display_value, exit_tick_display_value, and sell_spot_display_value.

5. Deprecated fields

The sell_spot and sell_spot_time fields are deprecated. Migrate to exit_spot and exit_spot_time.

6. is_forward_starting field removed

The is_forward_starting boolean flag has been removed.

7. Snowball contract fields removed

Snowball contract-specific fields have been removed: caution_price, profit_price, coupon_rate, etc.

Request structure

Legacy APIrequest example
{
  "proposal_open_contract": 1,
  "contract_id": 123456789,
  "subscribe": 1,
  "loginid": "CR90000001"
}
New APIrequest example
{
  "proposal_open_contract": 1,
  "contract_id": 123456789,
  "subscribe": 1
}

Response structure

Legacy APIresponse example
{
  "proposal_open_contract": {
    "contract_id": 123456789,
    "buy_price": 10.50,
    "display_value": "15.50",
    "payout": 20.00,
    "sell_spot": 1.0852
  },
  "msg_type": "proposal_open_contract"
}
New APIresponse example
{
  "proposal_open_contract": {
    "contract_id": 123456789,
    "buy_price": "10.50",
    "payout": "20.00",
    "exit_spot": "1.0852",
    "exit_spot_time": 1446629000
  },
  "msg_type": "proposal_open_contract"
}

Code examples

async function getOpenContract(contractId, loginId) {
  const request = {
    proposal_open_contract: 1,
    contract_id: contractId,
    subscribe: 1,
    loginid: loginId
  };

  ws.send(JSON.stringify(request));

  ws.onmessage = (event) => {
    const response = JSON.parse(event.data);
    if (response.msg_type === "proposal_open_contract") {
      const contract = response.proposal_open_contract;
      const profit = contract.profit;
      const displayValue = contract.display_value;
    }
  };
}

Any other questions? Get in touch

Click to open live chat support. Get instant help from our support team.