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

> ## Agent Instructions
> Base URL: https://api.eventory.ai. Send your API key in the apikey header. Market Data and Live Availability calls cost credits, pings included; GET /usage is free, so use it to test a key. Costs per endpoint: https://eventory.ai/docs/credits-and-access.md

# Live ticket availability for an event

> Fetches the current ticket availability for a single event on one of the
supported platforms (see `GET /events/platforms`).
The scrape runs synchronously and can take up to 60 seconds; set your client
timeout to at least 65 seconds.

A successful result is reused for 60 seconds: an identical request (same
`platform`, `event_id` and `region`) in that window returns it again, with
its original `scrape_timestamp`, and is billed like any other call.

The shape of `sections` depends on `sections_type`, which can differ between
events of the same platform. See the **Section types** guide.

**Cost:** 5 credits.




## OpenAPI

````yaml /openapi.yaml post /events/scrape
openapi: 3.1.0
info:
  title: Eventory API
  version: '1.0'
  description: >
    Every HTTP endpoint of the Eventory platform, reached through the single
    public

    gateway at `https://api.eventory.ai`. The Notifications API is a

    WebSocket and is documented separately under **Notifications API**.


    Authenticate every request with the `apikey` header. Each endpoint lists its

    credit cost; see **Credits & access** for how billing works.
  contact:
    name: Eventory
    url: https://eventory.ai
servers:
  - url: https://api.eventory.ai
    description: Production
security:
  - apiKey: []
tags:
  - name: Market Data
    description: |
      Historical and aggregated marketplace data for events and artists, plus
      full-text search over the Eventory catalog. Polling API.
      **1 credit per request** (sales list scales with rows requested).
  - name: Live Availability
    description: >
      On-demand scrape of the current ticket availability for one event on one
      of

      the twelve supported platforms. **5 credits per request.**
  - name: Watchlist
    description: |
      Manage the events your account monitors. The watchlist drives the
      Notifications API. **Free.**
  - name: Account
    description: Your plan and credit usage, live from billing. **Free.**
paths:
  /events/scrape:
    post:
      tags:
        - Live Availability
      summary: Scrape live availability
      description: >
        Fetches the current ticket availability for a single event on one of the

        supported platforms (see `GET /events/platforms`).

        The scrape runs synchronously and can take up to 60 seconds; set your
        client

        timeout to at least 65 seconds.


        A successful result is reused for 60 seconds: an identical request (same

        `platform`, `event_id` and `region`) in that window returns it again,
        with

        its original `scrape_timestamp`, and is billed like any other call.


        The shape of `sections` depends on `sections_type`, which can differ
        between

        events of the same platform. See the **Section types** guide.


        **Cost:** 5 credits.
      operationId: scrapeEvent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScrapeRequest'
            example:
              platform: dice_fm
              event_id: https://link.dice.fm/Q3dd78515650
              region: FR
      responses:
        '200':
          description: Current availability.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrapeResponse'
        '400':
          description: >-
            Unknown platform, a region the platform does not list, or an
            `event_id` it cannot take, such as a bare Eventim id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailError'
              examples:
                platform:
                  value:
                    detail: >-
                      Unsupported platform: dicefm. Supported: ['axs',
                      'dice_fm', 'eventim', 'fansale', 'seatgeek', 'stubhub',
                      'ticketek', 'ticketportal', 'tickpick', 'tm', 'viagogo',
                      'vividseats']
                region:
                  value:
                    detail: >-
                      Unsupported region: fr for platform fansale. Supported:
                      ['at', 'ch', 'de', 'dk', 'es', 'fi', 'it', 'nl', 'no',
                      'pl', 'uk']
                event_id:
                  value:
                    detail: >-
                      Eventim needs the full event URL, e.g.
                      https://www.eventim.de/en/event/artist-venue-12345/
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            Event not found on the platform (sold out, expired, removed, or
            wrong id).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailError'
              example:
                detail: Event not found
        '408':
          description: >-
            The platform took longer than 60 seconds. Retry once; if it persists
            the event id is probably wrong.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailError'
              example:
                detail: Scrape timed out after 60s
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServiceUnavailable'
        '502':
          $ref: '#/components/responses/ServiceUnavailable'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    ScrapeRequest:
      type: object
      required:
        - platform
        - event_id
        - region
      properties:
        platform:
          type: string
          description: Platform key from `GET /events/platforms`.
          enum:
            - tm
            - axs
            - dice_fm
            - eventim
            - fansale
            - seatgeek
            - stubhub
            - ticketek
            - ticketportal
            - tickpick
            - viagogo
            - vividseats
          example: dice_fm
        event_id:
          type: string
          description: >-
            The event's id on that platform. Some platforms take a bare id,
            others the full event URL; copy the format of `event_id_example`
            from `GET /events/platforms`. A bare Eventim id is rejected with
            `400`.
          example: https://link.dice.fm/Q3dd78515650
        region:
          type: string
          description: >-
            Country or region code (`US`, `UK`, `FR`, `IT`, …).
            Case-insensitive. Must be one of the platform's `regions` in `GET
            /events/platforms` unless those are `null`; any other value is
            rejected with `400`.
          example: FR
    ScrapeResponse:
      type: object
      properties:
        success:
          type: boolean
          description: '`true` if the event was found and data was returned.'
        platform:
          type: string
        event_id:
          type: string
        region:
          type: string
        scrape_timestamp:
          type: string
          format: date-time
        sections_type:
          type:
            - string
            - 'null'
          enum:
            - OfferSections
            - SeatMapSections
            - null
          description: >-
            The shape of `sections` in this response. It can differ from the
            platform's usual `sections_type` in `GET /events/platforms`, so
            dispatch on this one.
        total_stock:
          type:
            - integer
            - 'null'
          description: >-
            Total tickets available across all sections. `0` if sold out or not
            tracked.
        sections:
          type: object
          description: See the **Section types** guide.
          additionalProperties: true
        event_info:
          oneOf:
            - $ref: '#/components/schemas/EventInfo'
            - type: 'null'
        degraded:
          type:
            - string
            - 'null'
          description: >-
            Present on Ticketmaster scrapes when one data arm was unavailable.
            `v1` means resale/GA truth is missing and counts may be approximate;
            `v2` means seat-level detail is missing.
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: >-
            Platform-specific extras, e.g. `venue_map` on viagogo and StubHub.
            Treat as opaque.
        error:
          type:
            - string
            - 'null'
      example:
        success: true
        platform: dice_fm
        event_id: https://link.dice.fm/Q3dd78515650
        region: FR
        scrape_timestamp: '2026-06-12T10:00:00.000000+00:00'
        sections_type: OfferSections
        total_stock: 0
        sections:
          FINAL RELEASE - Entrance Before 5pm:
            offer_name: FINAL RELEASE - Entrance Before 5pm
            available: true
            price: 21.4
            price_label: EUR 21.40
            stock: null
            general_admission: null
            atc: null
          REGULAR FINAL RELEASE:
            offer_name: REGULAR FINAL RELEASE
            available: true
            price: 32.1
            price_label: EUR 32.10
            stock: null
            general_admission: null
            atc: null
        event_info:
          event_name: Croccante
          event_date: '2025-10-18T14:00:00+02:00'
          event_time: null
          event_venue: Balagan Roma
          event_venue_url: null
          event_artist_name: null
          event_location: Via Aldo Palazzeschi 125, 00137 Rome, Italy
          event_url: https://link.dice.fm/Q3dd78515650
          event_image: https://dice-media.imgix.net/example.jpg
        degraded: null
        error: null
    DetailError:
      type: object
      required:
        - detail
      properties:
        detail:
          type: string
    EventInfo:
      type: object
      description: Event metadata. Every field may be `null` depending on the platform.
      properties:
        event_name:
          type:
            - string
            - 'null'
        event_date:
          type:
            - string
            - 'null'
          description: ISO 8601 datetime, or a date alone when `event_time_tba` is `true`.
        event_timezone:
          type:
            - string
            - 'null'
          description: IANA time zone of the venue, e.g. `Europe/Madrid`, when known.
        event_time_tba:
          type:
            - boolean
            - 'null'
          description: '`true` when only the day is known.'
        event_time_local:
          type:
            - boolean
            - 'null'
          description: >-
            `true` when `event_date` is the venue's local time without a UTC
            offset.
        event_time:
          type:
            - string
            - 'null'
          description: Human-readable time
          if provided separately.: null
        event_venue:
          type:
            - string
            - 'null'
        event_venue_url:
          type:
            - string
            - 'null'
        event_artist_name:
          type:
            - string
            - 'null'
        event_location:
          type:
            - string
            - 'null'
        event_url:
          type:
            - string
            - 'null'
        event_image:
          type:
            - string
            - 'null'
    GatewayError:
      type: object
      description: >
        Envelope for every failure decided by the gateway (auth, ACL, billing,

        rate limit, unknown route, upstream 5xx). Key on `code`; `message` is
        prose

        and may change.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - unauthenticated
                - invalid_credentials
                - forbidden
                - no_subscription
                - limit_reached
                - no_billing_account
                - plan_unavailable
                - payment_required
                - invalid_parameter
                - rate_limited
                - not_found
                - service_unavailable
            message:
              type: string
  responses:
    Unauthenticated:
      description: No credential was sent, or the key was rejected.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          examples:
            missing:
              value:
                error:
                  code: unauthenticated
                  message: Authentication is required to access this resource.
            invalid:
              value:
                error:
                  code: invalid_credentials
                  message: Your credentials are invalid or expired.
    PaymentRequired:
      description: Billing denied the request. See `code`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          examples:
            limit:
              value:
                error:
                  code: limit_reached
                  message: You have reached your usage limit.
            subscription:
              value:
                error:
                  code: no_subscription
                  message: Your account has no active subscription.
    Forbidden:
      description: >-
        The key is valid but not granted this route. Contact support to enable
        it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          example:
            error:
              code: forbidden
              message: You do not have access to this service.
    RateLimited:
      description: >-
        Live Availability only. More than 30 requests per minute from your
        account. Back off.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          example:
            error:
              code: rate_limited
              message: Too many requests. Please slow down.
    ServiceUnavailable:
      description: The upstream service failed or is unreachable. Retry with backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GatewayError'
          example:
            error:
              code: service_unavailable
              message: The service is temporarily unavailable.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: Your Eventory API key. Sent as the `apikey` request header.

````

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