cyom

Get CYOM events

List create-your-own-market events. Users see their own; admins see all.

get/cyom-events

Request

Base URL: https://gamma-api.polymarket.com (the document declares no server; this is the origin it was published from)
URL: https://gamma-api.polymarket.com/cyom-events
Auth: one of:
- API key in cookie polymarketsession
- HTTP bearer

Query parameters

idinteger[] nullable

Event IDs to return

slugstring[] nullable

Event slugs to return

closedstring

Filter by closed flag (true/false)

livestring

Filter by live flag (true/false)

liquidity_minstring

Minimum liquidity

liquidity_maxstring

Maximum liquidity

volume_minstring

Minimum volume

volume_maxstring

Maximum volume

start_date_minstring

Minimum start date (RFC3339 or YYYY-MM-DD)

start_date_maxstring

Maximum start date (RFC3339 or YYYY-MM-DD)

end_date_minstring

Minimum end date (RFC3339 or YYYY-MM-DD)

end_date_maxstring

Maximum end date (RFC3339 or YYYY-MM-DD)

tag_idinteger[] nullable

Tag IDs to filter by

related_tagsstring

Include events from related tags (true/false)

tag_matchstring

Tag match mode

tag_slugstring

Filter by tag slug

featuredstring

Filter by featured flag (true/false)

cyomstring

Filter by CYOM flag (true/false)

series_idinteger[] nullable

Series IDs to filter by

series_slugstring[] nullable

Filter by series slug

game_idinteger[] nullable

Game IDs to filter by

us_idstring[] nullable

US event IDs to filter by

event_datestring

Filter by event date (RFC3339 or YYYY-MM-DD)

event_weekstring

Filter by event week

start_time_minstring

Minimum start time (RFC3339)

start_time_maxstring

Maximum start time (RFC3339)

exclude_tag_idinteger[] nullable

Tag IDs to exclude

featured_orderstring

Order by featured when true (true/false)

recurrence'daily' | 'weekly' | 'monthly' | 'annual' | 'hourly'

Recurrence filter

created_bystring[] nullable

Filter by creator

parent_event_idinteger[] nullable

Parent event IDs to filter by

include_childrenstring

Include the children of the matched parent_event_id or slug (true/false)

title_searchstring

Case-insensitive title search

include_best_linesstring

Include best lines (true/false)

include_marketsstring

Include each event's markets array (true/false, default true). false skips loading markets, so the response carries the event rows without a markets key

localestring

Locale code

partner_slugstring

Filter by external partner slug

event_metadata_keystring

Filter by event metadata key

event_metadata_valuestring

Filter by event metadata value

context_requires_regenstring

Return only events flagged for context regeneration when true; false has no effect

context_missingstring

Return only events with no generated context when true; false has no effect

combo_statusstring

Filter by combo status (pending/enabled/disabled). Returns events with at least one market in that status, counting markets owned by their child events, and narrows each event's markets array to that status.

versionstring[] nullable

Protocol versions to return (v1 or v2). Repeat the parameter for several. Omitted means the server default (v1 while polymarket-v2 is in its builder integration period)

limitinteger

Max results returned

offsetinteger

Number of results to skip

orderstring

Comma-separated field names to sort by

ascendingboolean

Sort ascending when true (default true)

after_cursorstring

Opaque keyset pagination cursor from a previous response

addressstring[] nullable

Filter by creator address

Response

$schemastring uri

A URL to the JSON Schema for this object.

activeboolean

archivedboolean

automaticallyActiveboolean

automaticallyResolvedboolean

cantEstimateboolean

carouselMapstring

categorystring

closedboolean

closedTimestring date-time

colorstring

commentCountinteger

commentsEnabledboolean

competitivenumber double

countryNamestring

createdAtstring date-time

createdBystring

creationDatestring date-time

cumulativeMarketsboolean

cyomboolean

deployingboolean

deployingTimestampstring date-time

descriptionstring

disqusThreadstring

elapsedstring

electionTypestring

enableNegRiskboolean

enableOrderBookboolean

endDatestring date-time

endedboolean

estimateValueboolean

estimatedValuestring

eventDatestring

eventMetadataobject

eventWeekinteger

featuredboolean

featuredImagestring

featuredOrderinteger

finishedTimestampstring date-time

gameIdinteger

gmpChartModestring

iconstring

idstring required

imagestring

isTemplateboolean

lastHighlightstring

lastHighlightAtstring date-time

lastHighlightTypestring

liquiditynumber double

liquidityAmmnumber double

liquidityClobnumber double

liveboolean

maxMarketCountinteger

Maximum number of markets the event can ever hold: the neg-risk arity packed into the v2 event id at first deployment (atomic neg-risk: equals the member count; incremental neg-risk: reserves slots for later appends). Null for binary events. Immutable once deployed — condition ids derive from it.

negRiskboolean

negRiskAugmentedboolean

negRiskFeeBipsinteger

negRiskMarketIDstring

newboolean

openInterestnumber double

parentEventIdinteger

pendingDeploymentboolean

periodstring

published_atstring

rescheduledFromGameIdinteger

resolutionSourcestring

restrictedboolean

scheduledDeploymentTimestampstring date-time

scorestring

seriesSlugstring

showAllOutcomesboolean

showMarketImagesboolean

slugstring

sortBystring

spreadsMainLinenumber double

startDatestring date-time

startTimestring date-time

subEventsstring[] nullable

subcategorystring

subtitlestring

tag_labelsstring[] nullable

tag_slugsstring[] nullable

templateVariablesstring

tickerstring

titlestring

totalsMainLinenumber double

turnProviderIdstring

tweetCountinteger

updatedAtstring date-time

updatedBystring

usIdstring

version'v1' | 'v2'

Protocol version of the event: v1 (legacy) or v2 (all child markets on polymarket-v2 modules). Clients must match exact values and treat unknown values as unsupported.

volumenumber double

volume1monumber double

volume1wknumber double

volume1yrnumber double

volume24hrnumber double

Example response

[
  {
    "$schema": "https://example.com/schemas/Event.json",
    "eventCreators": [
      {
        "$schema": "https://example.com/schemas/EventCreator.json"
      }
    ],
    "externalPartners": [
      {
        "$schema": "https://example.com/schemas/EventExternalPartnerMapping.json",
        "partner": {
          "$schema": "https://example.com/schemas/Partner.json"
        }
      }
    ],
    "markets": [
      {
        "$schema": "https://example.com/schemas/Market.json",
        "cryptoMarketConfig": {
          "$schema": "https://example.com/schemas/CryptoMarketConfig.json"
        },
        "tags": [
          {
            "$schema": "https://example.com/schemas/Tag.json"
          }
        ]
      }
    ],
    "series": [
      {
        "$schema": "https://example.com/schemas/Series.json"
      }
    ],
    "sport": {
      "$schema": "https://example.com/schemas/SportsMetadata.json",
      "externalPartners": [
        {
          "$schema": "https://example.com/schemas/SportExternalPartnerMapping.json",
          "partner": {
            "$schema": "https://example.com/schemas/Partner.json"
          }
        }
      ]
    },
    "tags": [
      {
        "$schema": "https://example.com/schemas/Tag.json"
      }
    ],
    "teams": [
      {
        "$schema": "https://example.com/schemas/Team.json",
        "externalPartners": [
          {
            "$schema": "https://example.com/schemas/TeamExternalPartnerMapping.json",
            "partner": {
              "$schema": "https://example.com/schemas/Partner.json"
            }
          }
        ]
      }
    ]
  }
]

Changes

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