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

# List Events

> List prediction-market events

> [!NOTE]
>
> **2** credits per request

***

> **You will get**
>
> * A paginated list of events (groups of related markets) across Polymarket, Kalshi and Polymarket US.
> * Filter by `active`, `closed`, and `source` (one venue: `polymarket`, `kalshi` or `polymarket-us`).
> * Choose the venues with `view`: `intl` (default) Polymarket and Kalshi, `us` Polymarket US and Kalshi, `all` every venue.
> * Sort by `volume24hr`, `volume`, or `endDate`.


## OpenAPI

````yaml /api-docs/api-reference/openapi.json get /v1/prediction/events
openapi: 3.0.0
info:
  title: CoinStats Public API
  description: >-
    CoinStats Public API — programmatic access to market data, news, NFTs,
    wallets, exchange connections, and user portfolios. Authenticate every
    request with the `X-API-KEY` header (or an OAuth Bearer token in the
    `Authorization` header). Generate keys at https://openapi.coinstats.app.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.coinstats.app
security: []
tags:
  - name: CoinStats
    description: ''
  - name: Market Data
    description: >-
      The Market Data section of the API provides endpoints to access a wide
      range of market-related information, including cryptocurrency coins,
      ticker data, and fiat currency rates. This category offers comprehensive
      data to help users monitor and analyze the cryptocurrency market, track
      prices, and gain insights into market trends
  - name: RWA
    description: >-
      Tokenized real-world assets: overview, stocks, commodities, ETFs, tokens,
      trading markets, and aggregate or per-asset history.
  - name: News
    description: >-
      The News section of the API allows you to access news articles and updates
      related to cryptocurrencies and the blockchain industry. It provides
      valuable information from various sources to keep you informed about the
      latest developments
  - name: NFTs
    description: >-
      The NFT section of the API provides endpoints to interact with
      Non-Fungible Tokens (NFTs), which are unique digital assets stored on a
      blockchain. These endpoints allow you to retrieve information about NFTs,
      including collections, assets, trending NFTs, and specific assets
      associated with wallet addresses.
  - name: Wallet NFTs
    description: >-
      NFTs held by a wallet: tokens, collections, value, activity and token
      gating
  - name: Wallet Data
    description: >-
      The Wallet section of the API provides a comprehensive set of endpoints to
      manage and interact with wallets. It enables users to retrieve wallet
      balances, monitor syncing status, fetch transaction data, and synchronize
      wallet information with the blockchain. By integrating these endpoints
      into your application, you can offer robust wallet functionality to your
      users.
  - name: Exchange Connection
    description: >-
      The Exchange Connection section of the API provides a comprehensive set of
      endpoints to manage and interact with exchanges. It enables users to
      retrieve exchange balances, monitor syncing status, fetch transaction
      data. By integrating these endpoints into your application, you can offer
      robust exchange portfolio tracking functionality to your users.
  - name: User Portfolio
    description: >-
      The Portfolio section of the API provides a comprehensive set of endpoints
      to manage and interact with Share Portfolios. It enables users to retrieve
      current Portfolio Coins and Transactions.
  - name: Usage
    description: The Usage section provides account-level API usage data.
  - name: Status
    description: The Status section provides API availability checks.
  - name: Prediction · Markets
    description: >-
      Polymarket, Kalshi and Polymarket US markets: list/trend/detail, live
      prices and order book, OHLC candles, and price history. `view` picks the
      venues a list shows (`intl` default, `us`, `all`). Prices are
      probabilities in 0..1, money is USD, dates are ISO 8601.
  - name: Prediction · Events
    description: >-
      Polymarket, Kalshi and Polymarket US events — groups of related markets
      (e.g. one market per candidate). List, trend, and fetch an event with its
      child markets.
  - name: Prediction · Traders
    description: >-
      Trader leaderboard plus deep per-trader analytics: profile, open
      positions, trade history, daily PnL, category stats, aggregate trade
      stats, and composite score.
  - name: Prediction · Analytics
    description: >-
      Platform-wide analytics: overview stats, smart-money and whale traders,
      trending-by-smart-money markets, and composite market signals.
  - name: Prediction · Search
    description: Full-text search across prediction-market events, markets, and traders.
paths:
  /v1/prediction/events:
    get:
      tags:
        - Prediction · Events
      summary: List prediction-market events
      operationId: list-events
      parameters:
        - name: active
          required: false
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: closed
          required: false
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: source
          required: false
          in: query
          description: >-
            One venue only: `polymarket` (Polymarket, polymarket.com), `kalshi`
            (Kalshi) or `polymarket-us` (Polymarket US, polymarket.us). Without
            it, the venues of `view`.
          schema:
            type: string
            enum:
              - polymarket
              - kalshi
              - polymarket-us
        - name: sort
          required: false
          in: query
          schema:
            default: volume24hr
            type: string
            enum:
              - volume24hr
              - volume
              - endDate
        - name: order
          required: false
          in: query
          schema:
            default: desc
            type: string
            enum:
              - asc
              - desc
        - name: limit
          required: false
          in: query
          schema:
            maximum: 100
            default: 50
            example: 50
            type: number
        - name: offset
          required: false
          in: query
          schema:
            default: 0
            example: 0
            type: number
        - name: view
          required: false
          in: query
          description: >-
            Which venues are listed when `source` names none: `intl` (default)
            Polymarket and Kalshi, as before Polymarket US was added; `us`
            Polymarket US and Kalshi; `all` every venue. In `all` each event is
            listed once: a Polymarket US event linked to its Polymarket twin is
            that twin's row, which names it in `linkedEvent`. With `source` set
            it no longer picks the rows, but still picks which venues' pairs
            annotate them (`pairedEvents`, `venueCount`). Polymarket US
            publishes no 24h volume (`volume24hr` is 0): sort its rows by
            `volume`.
          schema:
            default: intl
            type: string
            enum:
              - intl
              - us
              - all
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventListResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                statusCode: 400
                message: Bad Request
                requestId: 11111111-2222-3333-4444-555555555555
                path: <requested-endpoint>
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                statusCode: 401
                message: Unauthorized
                requestId: 11111111-2222-3333-4444-555555555555
                path: <requested-endpoint>
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                statusCode: 403
                message: Forbidden
                requestId: 11111111-2222-3333-4444-555555555555
                path: <requested-endpoint>
        '404':
          description: Not Found
          content:
            application/json:
              example:
                statusCode: 404
                message: Not Found
                requestId: 11111111-2222-3333-4444-555555555555
                path: <requested-endpoint>
        '409':
          description: Conflict (for some endpoints)
          content:
            application/json:
              example:
                statusCode: 409
                message: Transactions not synced
                requestId: 11111111-2222-3333-4444-555555555555
                path: <requested-endpoint>
        '429':
          description: Too Many Requests
          content:
            application/json:
              example:
                statusCode: 429
                message: Rate limit exceeded
                requestId: 11111111-2222-3333-4444-555555555555
                path: <requested-endpoint>
        '503':
          description: Service Unavailable
          content:
            application/json:
              example:
                statusCode: 503
                message: Service Unavailable. Please Contact Support
      security:
        - X-API-KEY: []
components:
  schemas:
    EventListResponseDto:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the request succeeded
          example: true
        timestamp:
          type: string
          description: ISO 8601 timestamp the response was generated
          example: '2025-06-19T12:00:00.000Z'
        data:
          type: array
          items:
            $ref: '#/components/schemas/EventDto'
        meta:
          $ref: '#/components/schemas/PredictionPageMetaDto'
      required:
        - success
        - timestamp
        - data
    EventDto:
      type: object
      properties:
        source:
          type: string
          enum:
            - polymarket
            - kalshi
            - polymarket-us
          example: polymarket
        linkedEvent:
          type: string
          description: >-
            The same event on Polymarket's other exchange: on a Polymarket US
            event its Polymarket (international) twin, on a Polymarket event its
            Polymarket US twin. Present only where one is linked.
          example: polymarket-us-nba-bos-det-2026-10-20
        linkedEventCategory:
          type: string
          description: 'With `linkedEvent`: the twin''s own category.'
          nullable: true
        sourceId:
          type: string
        eventId:
          type: number
        slug:
          type: string
          example: us-election-2024
        title:
          type: string
          example: 2024 US Presidential Election
        description:
          type: string
        image:
          type: string
        icon:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        volume:
          type: number
        volume24hr:
          type: number
        liquidity:
          type: number
        competitive:
          type: number
        active:
          type: boolean
        closed:
          type: boolean
        archived:
          type: boolean
        restricted:
          type: boolean
        marketIds:
          type: array
          items:
            type: string
        tagIds:
          type: array
          items:
            type: string
        seriesId:
          type: string
    PredictionPageMetaDto:
      type: object
      properties:
        total:
          type: number
          description: Total number of items
          example: 1240
        limit:
          type: number
          description: Page size
          example: 50
        offset:
          type: number
          description: Items skipped
          example: 0
        hasMore:
          type: boolean
          description: Whether more items are available beyond this page
          example: true
  securitySchemes:
    X-API-KEY:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        API key required to access the endpoints. Generate one from your
        dashboard at https://openapi.coinstats.app and pass it in the
        `X-API-KEY` request header. Never expose your key in client-side code.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.