Skip to main content
GET
/
api
/
workflows
/
polymarket
/
getEvent
Get Event
curl --request GET \
  --url https://api-v2.swaps.xyz/api/workflows/polymarket/getEvent \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "ticker": "<string>",
  "slug": "<string>",
  "title": "<string>",
  "subtitle": "<string>",
  "description": "<string>",
  "resolutionSource": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "creationDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "image": "<string>",
  "icon": "<string>",
  "active": true,
  "closed": true,
  "archived": true,
  "new": true,
  "featured": true,
  "restricted": true,
  "volume": 123,
  "volume24hr": 123,
  "volume1wk": 123,
  "volume1mo": 123,
  "volume1yr": 123,
  "openInterest": 123,
  "liquidity": 123,
  "liquidityAmm": 123,
  "liquidityClob": 123,
  "sortBy": "<string>",
  "category": "<string>",
  "subcategory": "<string>",
  "isTemplate": true,
  "templateVariables": "<string>",
  "published_at": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "commentsEnabled": true,
  "competitive": 123,
  "featuredImage": "<string>",
  "disqusThread": "<string>",
  "parentEvent": "<string>",
  "enableOrderBook": true,
  "negRisk": true,
  "negRiskMarketID": "<string>",
  "negRiskFeeBips": 123,
  "commentCount": 123,
  "imageOptimized": {},
  "iconOptimized": {},
  "featuredImageOptimized": {},
  "subEvents": [
    "<string>"
  ],
  "cyom": true,
  "closedTime": "2023-11-07T05:31:56Z",
  "showAllOutcomes": true,
  "showMarketImages": true,
  "automaticallyResolved": true,
  "enableNegRisk": true,
  "automaticallyActive": true,
  "eventDate": "<string>",
  "startTime": "2023-11-07T05:31:56Z",
  "eventWeek": 123,
  "seriesSlug": "<string>",
  "score": "<string>",
  "elapsed": "<string>",
  "period": "<string>",
  "live": true,
  "ended": true,
  "finishedTimestamp": "2023-11-07T05:31:56Z",
  "gmpChartMode": "<string>",
  "eventCreators": [
    {}
  ],
  "tweetCount": 123,
  "chats": [
    {}
  ],
  "featuredOrder": 123,
  "estimateValue": true,
  "cantEstimate": true,
  "estimatedValue": "<string>",
  "templates": [
    {}
  ],
  "spreadsMainLine": 123,
  "totalsMainLine": 123,
  "carouselMap": "<string>",
  "negRiskAugmented": true,
  "pendingDeployment": true,
  "deploying": true,
  "deployingTimestamp": "2023-11-07T05:31:56Z",
  "scheduledDeploymentTimestamp": "2023-11-07T05:31:56Z",
  "gameStatus": "<string>",
  "requiresTranslation": true,
  "markets": [
    {
      "id": "<string>",
      "question": "<string>",
      "conditionId": "<string>",
      "slug": "<string>",
      "resolutionSource": "<string>",
      "endDate": "2023-11-07T05:31:56Z",
      "liquidity": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "outcomes": "<string>",
      "outcomePrices": "<string>",
      "volume": "<string>",
      "active": true,
      "closed": true,
      "marketMakerAddress": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "new": true,
      "featured": true,
      "submitted_by": "<string>",
      "archived": true,
      "resolvedBy": "<string>",
      "restricted": true,
      "groupItemTitle": "<string>",
      "groupItemThreshold": "<string>",
      "questionID": "<string>",
      "enableOrderBook": true,
      "orderPriceMinTickSize": 123,
      "orderMinSize": 123,
      "volumeNum": 123,
      "liquidityNum": 123,
      "endDateIso": "<string>",
      "startDateIso": "<string>",
      "hasReviewedDates": true,
      "volume24hr": 123,
      "volume1wk": 123,
      "volume1mo": 123,
      "volume1yr": 123,
      "clobTokenIds": "<string>",
      "umaBond": "<string>",
      "umaReward": "<string>",
      "volume24hrAmm": 123,
      "volume1wkAmm": 123,
      "volume1moAmm": 123,
      "volume1yrAmm": 123,
      "volume24hrClob": 123,
      "volume1wkClob": 123,
      "volume1moClob": 123,
      "volume1yrClob": 123,
      "volumeAmm": 123,
      "volumeClob": 123,
      "liquidityAmm": 123,
      "liquidityClob": 123,
      "acceptingOrders": true,
      "negRisk": true,
      "negRiskMarketID": "<string>",
      "negRiskRequestID": "<string>",
      "ready": true,
      "funded": true,
      "acceptingOrdersTimestamp": "2023-11-07T05:31:56Z",
      "cyom": true,
      "competitive": 123,
      "pagerDutyNotificationEnabled": true,
      "approved": true,
      "clobRewards": [
        {}
      ],
      "rewardsMinSize": 123,
      "rewardsMaxSpread": 123,
      "spread": 123,
      "oneDayPriceChange": 123,
      "oneHourPriceChange": 123,
      "oneWeekPriceChange": 123,
      "oneMonthPriceChange": 123,
      "oneYearPriceChange": 123,
      "lastTradePrice": 123,
      "bestBid": 123,
      "bestAsk": 123,
      "automaticallyActive": true,
      "clearBookOnStart": true,
      "seriesColor": "<string>",
      "showGmpSeries": true,
      "showGmpOutcome": true,
      "manualActivation": true,
      "negRiskOther": true,
      "umaResolutionStatuses": "<string>",
      "pendingDeployment": true,
      "deploying": true,
      "rfqEnabled": true,
      "holdingRewardsEnabled": true,
      "feesEnabled": true,
      "image": "<string>",
      "icon": "<string>"
    }
  ],
  "series": [
    {
      "id": "<string>",
      "ticker": "<string>",
      "slug": "<string>",
      "title": "<string>",
      "seriesType": "<string>",
      "recurrence": "<string>",
      "image": "<string>",
      "icon": "<string>",
      "active": true,
      "closed": true,
      "archived": true,
      "featured": true,
      "restricted": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "volume": 123,
      "liquidity": 123,
      "commentCount": 123
    }
  ],
  "categories": [
    {}
  ],
  "collections": [
    {}
  ],
  "tags": [
    {
      "id": "<string>",
      "label": "<string>",
      "slug": "<string>",
      "forceShow": true,
      "publishedAt": "<string>",
      "createdBy": 123,
      "updatedBy": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "forceHide": true,
      "isCarousel": true,
      "requiresTranslation": true
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key for authentication. Contact Swaps.xyz to obtain an API key.

Query Parameters

slug
string
required

Event slug identifier

Response

Event details with markets

id
string
required

Unique event identifier

ticker
string | null

Event ticker symbol

slug
string | null

URL-friendly event identifier

title
string | null

Event title

subtitle
string | null

Event subtitle

description
string | null

Event description

resolutionSource
string | null

Source for event resolution

startDate
string<date-time> | null

Event start date

creationDate
string<date-time> | null

Event creation date

endDate
string<date-time> | null

Event end date

image
string | null

Event image URL

icon
string | null

Event icon URL

active
boolean | null

Whether event is active

closed
boolean | null

Whether event is closed

archived
boolean | null

Whether event is archived

new
boolean | null

Whether event is new

Whether event is featured

restricted
boolean | null

Whether event has restrictions

volume
number<float> | null

Total event volume

volume24hr
number<float> | null

24-hour trading volume

volume1wk
number<float> | null

1-week trading volume

volume1mo
number<float> | null

1-month trading volume

volume1yr
number<float> | null

1-year trading volume

openInterest
number<float> | null

Open interest

liquidity
number<float> | null

Total liquidity

liquidityAmm
number<float> | null

AMM liquidity

liquidityClob
number<float> | null

CLOB liquidity

sortBy
string | null

Sorting field (e.g., 'price')

category
string | null

Event category

subcategory
string | null

Event subcategory

isTemplate
boolean | null

Whether event is a template

templateVariables
string | null

Template variables

published_at
string | null

Publication timestamp

createdBy
string | null

Creator identifier

updatedBy
string | null

Last updater identifier

createdAt
string<date-time> | null

Event creation timestamp

updatedAt
string<date-time> | null

Event last update timestamp

commentsEnabled
boolean | null

Whether comments are enabled

competitive
number<float> | null

Competitiveness score (0-1)

Featured image URL

disqusThread
string | null

Disqus thread identifier

parentEvent
string | null

Parent event identifier

enableOrderBook
boolean | null

Whether order book is enabled

negRisk
boolean | null

Whether event uses negative risk

negRiskMarketID
string | null

Negative risk market ID

negRiskFeeBips
integer | null

Negative risk fee in basis points

commentCount
integer | null

Number of comments

imageOptimized
object

Optimized image metadata

iconOptimized
object

Optimized icon metadata

Optimized featured image metadata

subEvents
string[] | null

Sub-event identifiers

cyom
boolean | null

Create Your Own Market flag

closedTime
string<date-time> | null

Market close timestamp

showAllOutcomes
boolean | null

Whether to show all outcomes

showMarketImages
boolean | null

Whether to show market images

automaticallyResolved
boolean | null

Whether event is automatically resolved

enableNegRisk
boolean | null

Whether negative risk is enabled

automaticallyActive
boolean | null

Whether event is automatically active

eventDate
string | null

Event date

startTime
string<date-time> | null

Event start time

eventWeek
integer | null

Event week number

seriesSlug
string | null

Series slug identifier

score
string | null

Event score

elapsed
string | null

Elapsed time

period
string | null

Event period

live
boolean | null

Whether event is live

ended
boolean | null

Whether event has ended

finishedTimestamp
string<date-time> | null

Event finish timestamp

gmpChartMode
string | null

Chart mode (e.g., 'default')

eventCreators
object[] | null

Event creators

tweetCount
integer | null

Number of tweets

chats
object[] | null

Associated chats

Featured ordering position

estimateValue
boolean | null

Whether to estimate value

cantEstimate
boolean | null

Whether value cannot be estimated

estimatedValue
string | null

Estimated value

templates
object[] | null

Associated templates

spreadsMainLine
number<float> | null

Main line for spreads

totalsMainLine
number<float> | null

Main line for totals

Carousel mapping

negRiskAugmented
boolean | null

Whether negative risk is augmented

pendingDeployment
boolean | null

Whether deployment is pending

deploying
boolean | null

Whether currently deploying

deployingTimestamp
string<date-time> | null

Deployment timestamp

scheduledDeploymentTimestamp
string<date-time> | null

Scheduled deployment timestamp

gameStatus
string | null

Game status

requiresTranslation
boolean | null

Whether the event requires translation

markets
object[] | null

Markets associated with this event

series
object[] | null

Series associated with this event

categories
object[] | null

Categories associated with this event

collections
object[] | null

Collections associated with this event

tags
object[] | null

Tags associated with this event