Docs/API Reference/Markets

Markets

The Markets API manages trading venues and their associated listings, trading suspensions, and calendar schedules. Markets group instruments by the venue on which they trade.

/v1/workspaces/{workspaceId}
Market Types (read-only)MarketsMarket ListingsListing SuspensionsMarket Calendars

Market Types read-only

Market types classify venues (e.g. Exchange, OTC, Dark Pool). They are created by Editors and read by all robot roles.

GET/market-typesList market typesViewer+
GET/market-types/{id}Get a market typeViewer+
POST/market-types/filterFilter market typesViewer+
POST/market-types/countCount market typesViewer+

Markets

A market represents a trading venue such as ASX, NYSE, or a specific OTC desk. Markets carry custom field values defined by their market type schema.

GET/marketsList marketsViewer+
POST/marketsCreate a marketMember

Creates a market and upserts all field_values atomically.

Request body
{ "name": "Australian Securities Exchange", "identifier": "asx", "type_id": "exchange", "field_values": { "country": "AU", "timezone": "Australia/Sydney", "mic_code": "XASX" } }
Response — 201 Created
{ "id": "uuid", "identifier": "asx", "name": "Australian Securities Exchange", "type_id": "uuid", "extra_fields_snapshot": { "country": "AU", "timezone": "Australia/Sydney", "mic_code": "XASX" }, "archived_at": null, "created_at": "2026-04-15T09:00:00Z" }
GET/markets/{id}Get a marketViewer+
PATCH/markets/{id}Update a marketMember
DELETE/markets/{id}Archive a marketMember
DELETE/markets/{id}?hard=trueHard delete a marketMember
POST/markets/{id}/restoreRestore a marketMember
POST/markets/filterFilter marketsViewer+
POST/markets/countCount marketsViewer+

Market Listings

A market listing associates an instrument with a market (e.g. BHP listed on ASX). Listings carry additional metadata such as local ticker, currency, and lot size.

GET/market-listingsList market listingsViewer+
POST/market-listingsCreate a listingMember
GET/market-listings/{id}Get a listingViewer+
PATCH/market-listings/{id}Update a listingMember
DELETE/market-listings/{id}Archive a listingMember
POST/market-listings/{id}/restoreRestore a listingMember
POST/market-listings/filterFilter listingsViewer+
POST/market-listings/countCount listingsViewer+

Listing Suspensions

Suspensions record periods during which a listing was halted or suspended from trading. A listing may have multiple non-overlapping suspension periods.

Suspension periods must not overlap for the same listing. Creating an overlapping suspension returns 409 Conflict.
GET/market-listing-suspensionsList suspensionsViewer+
POST/market-listing-suspensionsCreate a suspensionMember
GET/market-listing-suspensions/{id}Get a suspensionViewer+
PATCH/market-listing-suspensions/{id}Update a suspensionMember
DELETE/market-listing-suspensions/{id}Delete a suspensionMember
POST/market-listing-suspensions/filterFilter suspensionsViewer+
POST/market-listing-suspensions/countCount suspensionsViewer+

Market Calendars

Market calendars define the trading schedule for a market: regular session hours, public holidays, and early-close days. A market can have one active calendar at a time.

GET/market-calendarsList market calendarsViewer+
POST/market-calendarsCreate a calendarMember
GET/market-calendars/{id}Get a calendarViewer+
PATCH/market-calendars/{id}Update a calendarMember
DELETE/market-calendars/{id}Archive a calendarMember
POST/market-calendars/{id}/restoreRestore a calendarMember
POST/market-calendars/filterFilter calendarsViewer+
POST/market-calendars/countCount calendarsViewer+
PrivacyTermsStatus© 2025 Ptolemy Pty Ltd