API Documentation

Overview

Our Exchange API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.

Authentication

Authentication is based on API Tokens plus a shared secret which is used to compute a required X-Signature header.

Credential Type

Description

Required Headers

Upload Credential

Used only to upload inventory either via the Auto Uploader software or via a special API endpoint.

X-Token

API Credential

The typical credential which acts on behalf of a Brokerage.

X-Token

X-Signature

User Credential

 A User Credential is used to act on behalf of a specific User and is need for certain endpoints.

X-Token

X-Signature

Environments

There are two distinct environments available for the API. The Production environment is the one your production applications should use, but a Sandbox environment is also provided for testing your integrations. The Sandbox is an environment completely isolated from Production, but has the same Events, Performers, Venues, and Configurations as the Production environment.

Environment

API URL

Sandbox

https://api.sandbox.ticketevolution.com

Production

https://api.ticketevolution.com

For more information on placing test orders in Sandbox see Placing Test Orders.

Pagination

Most endpoints support Pagination which allows you to adjust the quantity and range of results returned. The following query parameters will let you change the result set size for list endpoints and access additional pages.

  • per_page - defaults to 100, maximum of 100

  • page - defaults to 1

Conditionals

Most endpoints that accept date parameters such as updated_at or occurs_at support the following conditionals for creating a date range. The deleted endpoints utilize deleted_at.

  • .eq - equal (case-sensitive)

  • .not_eq - not equal (case-sensitive)

  • .gt - greater than

  • .gte - greater than or equal

  • .lt - less than

  • .lte - less than or equal

For example, this query would find all of the events occurring between May 15 and May 20, 2023:

/v9/events?occurs_at.gte=2023-05-15&occurs_at.lt=2023-05-20

Mailing List

Our low-volume mailing list for developers who are integrating with the Exchange API will keep you informed of changes, additions, and improvements to our APIs. Sign up at http://eepurl.com/ghzUOz .

Resources

Current Version

The current version of our API is version 9, indicated by using /v9/ in the URI.

  • Sandbox: https://api.sandbox.ticketevolution.com/v9/

  • Production: https://api.ticketevolution.com/v9/


Libraries

Recent updates