Event Contract Rules

GET

/v1/api/forecast/contract/rules

GET

/v1/api/forecast/contract/rules

curl -G https://localhost:5000/v1/api/forecast/contract/rules \
     -H "Authorization: Bearer <token>" \
     -d conid=conid

{
  "asset_class": "OPT",
  "description": "Carbon Dioxide is an important greenhouse gas and thought to be one of the major contributors to anthropogenic climate change, a major societal challenge. US Carbon Dioxide emissions estimate the amount of Carbon Dioxide emitted in the United States in a calendar year.",
  "market_name": "United States Carbon Dioxide Emissions",
  "measured_period": "Dec31'35",
  "threshold": "5050.0",
  "source_agency": "Energy Information Agency",
  "data_and_resolution_link": "https://www.eia.gov/environment/emissions/carbon/",
  "last_trade_time": 2093202000,
  "product_code": "USCE",
  "market_rules_link": "https://data.forecastex.com/regulatory/USCETermsandConditions.pdf",
  "release_time": 2093202000,
  "payout_time": 2093277600,
  "payout": "$1.00",
  "price_increment": "$0.01",
  "exchange_timezone": "US/Central"
}

Provides trading rules for specific event contracts.

Authentication

AuthorizationBearer

SSO bearer token.

Query parameters

conidstringRequired

Response

Returns the corresponding contracts rules.

asset_classstringOptional

Product asset class.

descriptionstringOptional

Long product description.

market_namestringOptional

Name of the contract's market.

measured_periodstringOptional

Measured period of the contract.

thresholdstringOptional

Either strike or strike label depending on contract type.

source_agencystringOptional

Name of the contract's source agency.

data_and_resolution_linkstringOptional

Link to data from source agency.

last_trade_timelongOptional

last trade time in epoch seconds.

product_codestringOptional

Product code (symbol).

market_rules_linkstringOptional

Link to market rules document.

release_timelongOptional

Release time in epoch seconds.

payout_timelongOptional

Payout time in epoch seconds.

payoutstringOptional

Formatted payout amount.

price_incrementstringOptional

Formatted price increment amount.

exchange_timezonestringOptional

Exchange timezone.

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error