> ## Documentation Index
> Fetch the complete documentation index at: https://docs.swaps.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Event

> Retrieve detailed information about a specific event, including all associated markets.



## OpenAPI

````yaml /prediction-market-data-reference/openapi.json get /api/workflows/polymarket/getEvent
openapi: 3.1.0
info:
  title: Prediction Market Data API
  description: >-
    Comprehensive API endpoints for querying data from prediction markets
    supported via workflows.
  version: 1.0.0
  contact:
    name: Swaps.xyz
    url: https://swaps.xyz
servers:
  - url: https://api-v2.swaps.xyz
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /api/workflows/polymarket/getEvent:
    get:
      summary: Get Event
      description: >-
        Retrieve detailed information about a specific event, including all
        associated markets.
      operationId: getEvent
      parameters:
        - name: slug
          in: query
          required: true
          description: Event slug identifier
          schema:
            type: string
          example: largest-company-end-of-2025
      responses:
        '200':
          description: Event details with markets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    Event:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: Unique event identifier
        ticker:
          type:
            - string
            - 'null'
          description: Event ticker symbol
        slug:
          type:
            - string
            - 'null'
          description: URL-friendly event identifier
        title:
          type:
            - string
            - 'null'
          description: Event title
        subtitle:
          type:
            - string
            - 'null'
          description: Event subtitle
        description:
          type:
            - string
            - 'null'
          description: Event description
        resolutionSource:
          type:
            - string
            - 'null'
          description: Source for event resolution
        startDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Event start date
        creationDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Event creation date
        endDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Event end date
        image:
          type:
            - string
            - 'null'
          description: Event image URL
        icon:
          type:
            - string
            - 'null'
          description: Event icon URL
        active:
          type:
            - boolean
            - 'null'
          description: Whether event is active
        closed:
          type:
            - boolean
            - 'null'
          description: Whether event is closed
        archived:
          type:
            - boolean
            - 'null'
          description: Whether event is archived
        new:
          type:
            - boolean
            - 'null'
          description: Whether event is new
        featured:
          type:
            - boolean
            - 'null'
          description: Whether event is featured
        restricted:
          type:
            - boolean
            - 'null'
          description: Whether event has restrictions
        volume:
          type:
            - number
            - 'null'
          format: float
          description: Total event volume
        volume24hr:
          type:
            - number
            - 'null'
          format: float
          description: 24-hour trading volume
        volume1wk:
          type:
            - number
            - 'null'
          format: float
          description: 1-week trading volume
        volume1mo:
          type:
            - number
            - 'null'
          format: float
          description: 1-month trading volume
        volume1yr:
          type:
            - number
            - 'null'
          format: float
          description: 1-year trading volume
        openInterest:
          type:
            - number
            - 'null'
          format: float
          description: Open interest
        liquidity:
          type:
            - number
            - 'null'
          format: float
          description: Total liquidity
        liquidityAmm:
          type:
            - number
            - 'null'
          format: float
          description: AMM liquidity
        liquidityClob:
          type:
            - number
            - 'null'
          format: float
          description: CLOB liquidity
        sortBy:
          type:
            - string
            - 'null'
          description: Sorting field (e.g., 'price')
        category:
          type:
            - string
            - 'null'
          description: Event category
        subcategory:
          type:
            - string
            - 'null'
          description: Event subcategory
        isTemplate:
          type:
            - boolean
            - 'null'
          description: Whether event is a template
        templateVariables:
          type:
            - string
            - 'null'
          description: Template variables
        published_at:
          type:
            - string
            - 'null'
          description: Publication timestamp
        createdBy:
          type:
            - string
            - 'null'
          description: Creator identifier
        updatedBy:
          type:
            - string
            - 'null'
          description: Last updater identifier
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Event creation timestamp
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Event last update timestamp
        commentsEnabled:
          type:
            - boolean
            - 'null'
          description: Whether comments are enabled
        competitive:
          type:
            - number
            - 'null'
          format: float
          description: Competitiveness score (0-1)
        featuredImage:
          type:
            - string
            - 'null'
          description: Featured image URL
        disqusThread:
          type:
            - string
            - 'null'
          description: Disqus thread identifier
        parentEvent:
          type:
            - string
            - 'null'
          description: Parent event identifier
        enableOrderBook:
          type:
            - boolean
            - 'null'
          description: Whether order book is enabled
        negRisk:
          type:
            - boolean
            - 'null'
          description: Whether event uses negative risk
        negRiskMarketID:
          type:
            - string
            - 'null'
          description: Negative risk market ID
        negRiskFeeBips:
          type:
            - integer
            - 'null'
          description: Negative risk fee in basis points
        commentCount:
          type:
            - integer
            - 'null'
          description: Number of comments
        imageOptimized:
          type:
            - object
            - 'null'
          description: Optimized image metadata
        iconOptimized:
          type:
            - object
            - 'null'
          description: Optimized icon metadata
        featuredImageOptimized:
          type:
            - object
            - 'null'
          description: Optimized featured image metadata
        subEvents:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Sub-event identifiers
        cyom:
          type:
            - boolean
            - 'null'
          description: Create Your Own Market flag
        closedTime:
          type:
            - string
            - 'null'
          format: date-time
          description: Market close timestamp
        showAllOutcomes:
          type:
            - boolean
            - 'null'
          description: Whether to show all outcomes
        showMarketImages:
          type:
            - boolean
            - 'null'
          description: Whether to show market images
        automaticallyResolved:
          type:
            - boolean
            - 'null'
          description: Whether event is automatically resolved
        enableNegRisk:
          type:
            - boolean
            - 'null'
          description: Whether negative risk is enabled
        automaticallyActive:
          type:
            - boolean
            - 'null'
          description: Whether event is automatically active
        eventDate:
          type:
            - string
            - 'null'
          description: Event date
        startTime:
          type:
            - string
            - 'null'
          format: date-time
          description: Event start time
        eventWeek:
          type:
            - integer
            - 'null'
          description: Event week number
        seriesSlug:
          type:
            - string
            - 'null'
          description: Series slug identifier
        score:
          type:
            - string
            - 'null'
          description: Event score
        elapsed:
          type:
            - string
            - 'null'
          description: Elapsed time
        period:
          type:
            - string
            - 'null'
          description: Event period
        live:
          type:
            - boolean
            - 'null'
          description: Whether event is live
        ended:
          type:
            - boolean
            - 'null'
          description: Whether event has ended
        finishedTimestamp:
          type:
            - string
            - 'null'
          format: date-time
          description: Event finish timestamp
        gmpChartMode:
          type:
            - string
            - 'null'
          description: Chart mode (e.g., 'default')
        eventCreators:
          type:
            - array
            - 'null'
          items:
            type: object
          description: Event creators
        tweetCount:
          type:
            - integer
            - 'null'
          description: Number of tweets
        chats:
          type:
            - array
            - 'null'
          items:
            type: object
          description: Associated chats
        featuredOrder:
          type:
            - integer
            - 'null'
          description: Featured ordering position
        estimateValue:
          type:
            - boolean
            - 'null'
          description: Whether to estimate value
        cantEstimate:
          type:
            - boolean
            - 'null'
          description: Whether value cannot be estimated
        estimatedValue:
          type:
            - string
            - 'null'
          description: Estimated value
        templates:
          type:
            - array
            - 'null'
          items:
            type: object
          description: Associated templates
        spreadsMainLine:
          type:
            - number
            - 'null'
          format: float
          description: Main line for spreads
        totalsMainLine:
          type:
            - number
            - 'null'
          format: float
          description: Main line for totals
        carouselMap:
          type:
            - string
            - 'null'
          description: Carousel mapping
        negRiskAugmented:
          type:
            - boolean
            - 'null'
          description: Whether negative risk is augmented
        pendingDeployment:
          type:
            - boolean
            - 'null'
          description: Whether deployment is pending
        deploying:
          type:
            - boolean
            - 'null'
          description: Whether currently deploying
        deployingTimestamp:
          type:
            - string
            - 'null'
          format: date-time
          description: Deployment timestamp
        scheduledDeploymentTimestamp:
          type:
            - string
            - 'null'
          format: date-time
          description: Scheduled deployment timestamp
        gameStatus:
          type:
            - string
            - 'null'
          description: Game status
        requiresTranslation:
          type:
            - boolean
            - 'null'
          description: Whether the event requires translation
        markets:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/Market'
          description: Markets associated with this event
        series:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/Series'
          description: Series associated with this event
        categories:
          type:
            - array
            - 'null'
          items:
            type: object
          description: Categories associated with this event
        collections:
          type:
            - array
            - 'null'
          items:
            type: object
          description: Collections associated with this event
        tags:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags associated with this event
    Market:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: Unique market identifier
        question:
          type:
            - string
            - 'null'
          description: Market question
        conditionId:
          type:
            - string
            - 'null'
          description: Condition ID for the market
        slug:
          type:
            - string
            - 'null'
          description: URL-friendly market identifier
        resolutionSource:
          type:
            - string
            - 'null'
          description: Source for market resolution
        endDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Market end date
        liquidity:
          type:
            - string
            - 'null'
          description: Market liquidity
        startDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Market start date
        description:
          type:
            - string
            - 'null'
          description: Detailed market description
        outcomes:
          type:
            - string
            - 'null'
          description: JSON string of possible outcomes
        outcomePrices:
          type:
            - string
            - 'null'
          description: JSON string of outcome prices
        volume:
          type:
            - string
            - 'null'
          description: Market trading volume
        active:
          type:
            - boolean
            - 'null'
          description: Whether market is active
        closed:
          type:
            - boolean
            - 'null'
          description: Whether market is closed
        marketMakerAddress:
          type:
            - string
            - 'null'
          description: Market maker address
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Market creation timestamp
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Market last update timestamp
        new:
          type:
            - boolean
            - 'null'
          description: Whether market is new
        featured:
          type:
            - boolean
            - 'null'
          description: Whether market is featured
        submitted_by:
          type:
            - string
            - 'null'
          description: Address of user who submitted the market
        archived:
          type:
            - boolean
            - 'null'
          description: Whether market is archived
        resolvedBy:
          type:
            - string
            - 'null'
          description: Address of resolver
        restricted:
          type:
            - boolean
            - 'null'
          description: Whether market has restrictions
        groupItemTitle:
          type:
            - string
            - 'null'
          description: Group item title
        groupItemThreshold:
          type:
            - string
            - 'null'
          description: Group item threshold
        questionID:
          type:
            - string
            - 'null'
          description: Question ID
        enableOrderBook:
          type:
            - boolean
            - 'null'
          description: Whether order book is enabled
        orderPriceMinTickSize:
          type:
            - number
            - 'null'
          format: float
          description: Minimum tick size for orders
        orderMinSize:
          type:
            - number
            - 'null'
          format: float
          description: Minimum order size
        volumeNum:
          type:
            - number
            - 'null'
          format: float
          description: Numeric volume
        liquidityNum:
          type:
            - number
            - 'null'
          format: float
          description: Numeric liquidity
        endDateIso:
          type:
            - string
            - 'null'
          description: ISO date string of end date
        startDateIso:
          type:
            - string
            - 'null'
          description: ISO date string of start date
        hasReviewedDates:
          type:
            - boolean
            - 'null'
          description: Whether dates have been reviewed
        volume24hr:
          type:
            - number
            - 'null'
          format: float
          description: 24-hour trading volume
        volume1wk:
          type:
            - number
            - 'null'
          format: float
          description: 1-week trading volume
        volume1mo:
          type:
            - number
            - 'null'
          format: float
          description: 1-month trading volume
        volume1yr:
          type:
            - number
            - 'null'
          format: float
          description: 1-year trading volume
        clobTokenIds:
          type:
            - string
            - 'null'
          description: JSON string of CLOB token IDs
        umaBond:
          type:
            - string
            - 'null'
          description: UMA bond amount
        umaReward:
          type:
            - string
            - 'null'
          description: UMA reward amount
        volume24hrAmm:
          type:
            - number
            - 'null'
          format: float
          description: 24-hour AMM volume
        volume1wkAmm:
          type:
            - number
            - 'null'
          format: float
          description: 1-week AMM volume
        volume1moAmm:
          type:
            - number
            - 'null'
          format: float
          description: 1-month AMM volume
        volume1yrAmm:
          type:
            - number
            - 'null'
          format: float
          description: 1-year AMM volume
        volume24hrClob:
          type:
            - number
            - 'null'
          format: float
          description: 24-hour CLOB volume
        volume1wkClob:
          type:
            - number
            - 'null'
          format: float
          description: 1-week CLOB volume
        volume1moClob:
          type:
            - number
            - 'null'
          format: float
          description: 1-month CLOB volume
        volume1yrClob:
          type:
            - number
            - 'null'
          format: float
          description: 1-year CLOB volume
        volumeAmm:
          type:
            - number
            - 'null'
          format: float
          description: Total AMM volume
        volumeClob:
          type:
            - number
            - 'null'
          format: float
          description: Total CLOB volume
        liquidityAmm:
          type:
            - number
            - 'null'
          format: float
          description: AMM liquidity
        liquidityClob:
          type:
            - number
            - 'null'
          format: float
          description: CLOB liquidity
        acceptingOrders:
          type:
            - boolean
            - 'null'
          description: Whether market is accepting orders
        negRisk:
          type:
            - boolean
            - 'null'
          description: Whether market uses negative risk
        negRiskMarketID:
          type:
            - string
            - 'null'
          description: Negative risk market ID
        negRiskRequestID:
          type:
            - string
            - 'null'
          description: Negative risk request ID
        ready:
          type:
            - boolean
            - 'null'
          description: Whether market is ready
        funded:
          type:
            - boolean
            - 'null'
          description: Whether market is funded
        acceptingOrdersTimestamp:
          type:
            - string
            - 'null'
          format: date-time
          description: When market started accepting orders
        cyom:
          type:
            - boolean
            - 'null'
          description: Create Your Own Market flag
        competitive:
          type:
            - number
            - 'null'
          format: float
          description: Competitiveness score
        pagerDutyNotificationEnabled:
          type:
            - boolean
            - 'null'
          description: Whether PagerDuty notifications are enabled
        approved:
          type:
            - boolean
            - 'null'
          description: Whether market is approved
        clobRewards:
          type:
            - array
            - 'null'
          items:
            type: object
          description: CLOB rewards
        rewardsMinSize:
          type:
            - number
            - 'null'
          format: float
          description: Minimum size for rewards
        rewardsMaxSpread:
          type:
            - number
            - 'null'
          format: float
          description: Maximum spread for rewards
        spread:
          type:
            - number
            - 'null'
          format: float
          description: Current spread
        oneDayPriceChange:
          type:
            - number
            - 'null'
          format: float
          description: 1-day price change
        oneHourPriceChange:
          type:
            - number
            - 'null'
          format: float
          description: 1-hour price change
        oneWeekPriceChange:
          type:
            - number
            - 'null'
          format: float
          description: 1-week price change
        oneMonthPriceChange:
          type:
            - number
            - 'null'
          format: float
          description: 1-month price change
        oneYearPriceChange:
          type:
            - number
            - 'null'
          format: float
          description: 1-year price change
        lastTradePrice:
          type:
            - number
            - 'null'
          format: float
          description: Last trade price
        bestBid:
          type:
            - number
            - 'null'
          format: float
          description: Best bid price
        bestAsk:
          type:
            - number
            - 'null'
          format: float
          description: Best ask price
        automaticallyActive:
          type:
            - boolean
            - 'null'
          description: Whether market is automatically active
        clearBookOnStart:
          type:
            - boolean
            - 'null'
          description: Whether to clear book on start
        seriesColor:
          type:
            - string
            - 'null'
          description: Series color
        showGmpSeries:
          type:
            - boolean
            - 'null'
          description: Whether to show GMP series
        showGmpOutcome:
          type:
            - boolean
            - 'null'
          description: Whether to show GMP outcome
        manualActivation:
          type:
            - boolean
            - 'null'
          description: Whether market requires manual activation
        negRiskOther:
          type:
            - boolean
            - 'null'
          description: Other negative risk flag
        umaResolutionStatuses:
          type:
            - string
            - 'null'
          description: JSON string of UMA resolution statuses
        pendingDeployment:
          type:
            - boolean
            - 'null'
          description: Whether deployment is pending
        deploying:
          type:
            - boolean
            - 'null'
          description: Whether currently deploying
        rfqEnabled:
          type:
            - boolean
            - 'null'
          description: Whether RFQ is enabled
        holdingRewardsEnabled:
          type:
            - boolean
            - 'null'
          description: Whether holding rewards are enabled
        feesEnabled:
          type:
            - boolean
            - 'null'
          description: Whether fees are enabled
        image:
          type:
            - string
            - 'null'
          description: Market image URL
        icon:
          type:
            - string
            - 'null'
          description: Market icon URL
    Series:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: Unique series identifier
        ticker:
          type:
            - string
            - 'null'
          description: Series ticker symbol
        slug:
          type:
            - string
            - 'null'
          description: URL-friendly series identifier
        title:
          type:
            - string
            - 'null'
          description: Series title
        seriesType:
          type:
            - string
            - 'null'
          description: Type of series (e.g., 'single')
        recurrence:
          type:
            - string
            - 'null'
          description: Recurrence pattern (e.g., 'monthly', 'weekly')
        image:
          type:
            - string
            - 'null'
          description: Series image URL
        icon:
          type:
            - string
            - 'null'
          description: Series icon URL
        active:
          type:
            - boolean
            - 'null'
          description: Whether series is active
        closed:
          type:
            - boolean
            - 'null'
          description: Whether series is closed
        archived:
          type:
            - boolean
            - 'null'
          description: Whether series is archived
        featured:
          type:
            - boolean
            - 'null'
          description: Whether series is featured
        restricted:
          type:
            - boolean
            - 'null'
          description: Whether series has restrictions
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Series creation timestamp
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Series last update timestamp
        volume:
          type:
            - number
            - 'null'
          format: float
          description: Total series volume
        liquidity:
          type:
            - number
            - 'null'
          format: float
          description: Total series liquidity
        commentCount:
          type:
            - integer
            - 'null'
          description: Number of comments on series
    Tag:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          description: Unique tag identifier
        label:
          type: string
          nullable: true
          description: Human-readable tag label
        slug:
          type: string
          nullable: true
          description: URL-friendly tag identifier
        forceShow:
          type: boolean
          nullable: true
          description: Whether to force show this tag
        publishedAt:
          type: string
          nullable: true
          description: 'Tag publication timestamp (format: YYYY-MM-DD HH:mm:ss.SSS+00)'
        createdBy:
          type: integer
          nullable: true
          description: ID of user who created the tag
        updatedBy:
          type: integer
          nullable: true
          description: ID of user who last updated the tag
        createdAt:
          type: string
          format: date-time
          nullable: true
          description: Tag creation timestamp
        updatedAt:
          type: string
          format: date-time
          nullable: true
          description: Tag last update timestamp
        forceHide:
          type: boolean
          nullable: true
          description: Whether to force hide this tag
        isCarousel:
          type: boolean
          nullable: true
          description: Whether this tag is a carousel tag
        requiresTranslation:
          type: boolean
          nullable: true
          description: Whether this tag requires translation
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error message
        code:
          type: integer
          description: Error code
        details:
          type: object
          description: Additional error details
  responses:
    BadRequest:
      description: Bad request due to missing or invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Contact Swaps.xyz to obtain an API key.

````