Catalog

Get a market

Keytrading trading::read
Throttleread
Cost1 /request
Answers<span class="st st-ok">200</span> <span class="st st-warn">401</span> <span class="st st-warn">403</span> <span class="st st-warn">404</span> <span class="st st-hold">423</span> <span class="st st-hold">429</span> <span class="st st-warn">451</span>
Idempotenttrue

Also served without a signature at GET /v3/public/catalog/markets/{id}. The edge throttles it per IP.

get/v3/catalog/markets/{id}

Request

  • Base URL: https://api.paper.novig.com
  • URL: https://api.paper.novig.com/v3/catalog/markets/{id}
  • Auth: API key in header Novig-Key-Id and API key in header Novig-Signature and API key in header Novig-Timestamp

Path parameters

idstring uuid required

Market ID.

Response

The market.

descriptionstring required

Human-readable. Use it for discovery, never as a contract.

eventIdstring uuid required

ID of the event the market belongs to.

marketIdstring uuid required

Market ID.

marketTypestring required

A canonical name from GET /v3/types/markets.

startsTsinteger required

Unix milliseconds.

status'OPEN' | 'CLOSED' | 'SETTLED' required

Lifecycle status of a market.

strikestring

The line the market settles against, a decimal string. A spread's line is the home side's handicap. Absent on a market without a line.

voids'PUSH' | 'FMV' required

How a market settles if it voids. PUSH refunds every fill at its cost. FMV settles every outcome at its fair market value. The exchange never pushes an FMV market. Do not assume a refund.

Example response

{
  "marketType": "MONEY",
  "strike": "-3.5"
}

Changes

No recorded changes to this operation across all 1 revision of this API.