Back to top

Ticketbis API

This is the official Ticketbis API that gives you access to our resources.

NOTE: This document is a work in progress.

Overview

Headers

Request headers

header value required description
Content-Type application/json true only json supported so far
Authorization Bearer access_token true check Authentication section to see how to get the access token
X-ticketbis-site site_name false requests are site specific. A list of available sites can be retrieved from sites endpoint
Accept-Language locale false since each site is assigned to a locale, you can request resources for a specific site by locale (defaults to en_GB). No X-ticketbis-site header required when Accept-Language provided
curl -H "Authorization: Bearer adsf7788dsf6a6df6" -H "X-ticketbis-site: ticketbisES" -H "Content-Type: application/json" -XGET https://api.ticketbis.com/events

Response headers

header type description
X-ticketbis-pageMaxSize integer max number of results per page
X-ticketbis-pageOffset integer current page offset
X-ticketbis-site string Ticketbis site for traceability (). i.e: ticketbisES
X-ticketbis-totalCount integer number of total results

Parameters

Many API methods take optional parameters. For GET requests, any parameters not specified as a segment in the path can be passed as an HTTP query string parameter. Generic parameters are listed below:

parameter type description
max integer Pagination parameter: max results per page
offset integer Pagination parameter: offset
embedded string A comma separated string for additional details that are not returned by default
q string The filter keywords, as well as any qualifiers. It’s a space separated string that allows to combine qualifiers and search keywords

This is a list of common q qualifiers:

qualifier format description
id comma separated string represents a list of ids. i.e: id:1,2,3,4
updated [<>=]utc_datetime last time resource was updated. i.e: updated:>2016-10-18T00:00:00Z

Example

Events updated after october 18th and including venue and breadcrumb details. Results are paginated with 5 events per page (HTTP headers omitted)

curl https://api.ticketbis.com/events?q=updated:>2016-10-18T00:00:00Z&embedded=breadcrumb,venue&max=5&offset=10

Authentication

Oauth2 key/secret

This should only be used in server to server scenarios. Don’t leak your OAuth application’s client secret to your users.

Oauth2 key/secret
POST/oauth/token?grant_type=client_credentials&client_id={client_id}&client_secret={client_secret}&scope=read

Example URI

POST http://api.ticketbis.com/oauth/token?grant_type=client_credentials&client_id=xxxx&client_secret=yyyy&scope=read
URI Parameters
HideShow
client_id
string (required) Example: xxxx

Client id provided by Ticketbis.

client_secret
string (required) Example: yyyy

Client secret provided by Ticketbis.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "access_token": "your_access_token",
  "token_type": "Bearer",
  "expires_in": 36000,
  "scope": "read"
}

Events

Event

Returns a specific Event.

Gets an Event
GET/events/{id}{?embedded}

Example URI

GET http://api.ticketbis.com/events/1?embedded=breadcrumb
URI Parameters
HideShow
id
string (required) Example: 1

Event id.

embedded
String (optional) Example: breadcrumb

Embedded resources options: breadcrumb.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 91300,
  "name": "Wimbledon 2016 - Semifinales masculinas",
  "url": "http://www.ticketbis.com/wimbledon-2016-semifinales-masculinas-tickets/ev91300",
  "date": "2016-07-08T12:00:00Z",
  "localized_date": "08/07/2016-13:00",
  "updated_time": "2016-05-19T17:40:28Z",
  "timezone": "Europe/London",
  "image": "image url",
  "min_price": null,
  "lastminute": false,
  "shipment_deadline": "2016-07-08T00:00:00Z",
  "description": "description",
  "venue": {
    "id": 731,
    "name": "Centre Court",
    "city": "London",
    "address": "Wimbledon, Merton, London SW19 5",
    "country": "United Kingdom",
    "country_code": "GB",
    "latitude": 51.4307578,
    "longitude": -0.19199
  },
  "schema": {
    "id": 731,
    "name": "Centre Court-esquema",
    "static_image": "image url",
    "dynamic_image": null,
    "venue_schema_id": null,
    "general_admission": false
  },
  "dynamic_map": null,
  "breadcrumb": [
    {
      "id": 1,
      "name": "Sports",
      "depth": 1,
      "url": "http://www.ticketbis.com/sports-tickets/ca1",
      "events_count": 870
    },
    {
      "id": 72,
      "name": "Tennis",
      "depth": 2,
      "url": "http://www.ticketbis.com/tennis-tickets/ca72",
      "events_count": 106
    },
    {
      "id": 735,
      "name": "Wimbledon",
      "depth": 4,
      "url": "http://www.ticketbis.com/wimbledon-tickets/ca735",
      "events_count": 23
    },
    {
      "id": 6612,
      "name": "Wimbledon Semi Finals",
      "depth": 5,
      "url": "http://www.ticketbis.com/wimbledon-semi-finals-tickets/ca6612",
      "events_count": 3
    }
  ]
}

Events Collection

A Collection of events.

All Events
GET/events{?q,embedded,max,offset}

Example URI

GET http://api.ticketbis.com/events?q=updated:>2015-03-04T20:00:00Z&embedded=breadcrumb&max=50&offset=0
URI Parameters
HideShow
q
String (optional) Example: updated:>2015-03-04T20:00:00Z

Accepted qualifiers: id, updated.

embedded
String (optional) Example: breadcrumb

Embedded resources options: breadcrumb.

max
Long (optional) Example: 50

Max items per page.

offset
Long (optional) Example: 0

Current offset.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 68966,
        ...
    },
    {
        "id": 68967,
        ...
    }
]

Events Collection by Category

A Collection of events filtered by category.

Events by Category
GET/categories/{id}/events{?q,embedded,max,offset}

Example URI

GET http://api.ticketbis.com/categories/1/events?q=updated:>2015-03-04T20:00:00Z&embedded=breadcrumb&max=50&offset=0
URI Parameters
HideShow
id
string (required) Example: 1

Category id.

q
String (optional) Example: updated:>2015-03-04T20:00:00Z

Accepted qualifiers: id, updated.

embedded
String (optional) Example: breadcrumb

Embedded resources options: breadcrumb.

max
Long (optional) Example: 50

Max items per page.

offset
Long (optional) Example: 0

Current offset.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 68966,
        ...
    },
    {
        "id": 68967,
        ...
    }
]

Categories

Category

Returns a specific category.

Gets a Category
GET/categories/{id}{?embedded}

Example URI

GET http://api.ticketbis.com/categories/1?embedded=breadcrumb
URI Parameters
HideShow
id
string (required) Example: 1

Category id.

embedded
String (optional) Example: breadcrumb

Embedded resources options: breadcrumb.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 14,
  "name": "La Liga",
  "depth": 4,
  "url": "http://www.ticketbis.com/la-liga-tickets/ca14",
  "events_count": 9,
  "title": "La Liga Tickets | Ticketbis UK",
  "leaf": false,
  "image": "image url",
  "description": "Category description",
  "meta_description": "Meta-description",
  "breadcrumb": [
    {
      "id": 1,
      "name": "Sports",
      "depth": 1,
      "url": "http://www.ticketbis.com/sports-tickets/ca1",
      "events_count": 870
    },
    {
      "id": 5,
      "name": "Football",
      "depth": 2,
      "url": "http://www.ticketbis.com/football-tickets/ca5",
      "events_count": 167
    },
    {
      "id": 9,
      "name": "Competitions",
      "depth": 3,
      "url": "http://www.ticketbis.com/competitions-tickets/ca9",
      "events_count": 149
    }
  ]
}

Categories Collection

A Collection of categories.

All Categories
GET/categories{?q,embedded,max,offset}

Example URI

GET http://api.ticketbis.com/categories?q=updated:>2015-03-04T20:00:00Z&embedded=breadcrumb&max=50&offset=0
URI Parameters
HideShow
q
String (optional) Example: updated:>2015-03-04T20:00:00Z

Accepted qualifiers: id, updated.

embedded
String (optional) Example: breadcrumb

Embedded resources options: breadcrumb.

max
Long (optional) Example: 50

Max items per page.

offset
Long (optional) Example: 0

Current offset.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 68966,
        ...
    },
    {
        "id": 68967,
        ...
    }
]

Categories Collection by Category

A Collection of descendants categories filtered by category.

Categories by Category
GET/categories/{id}/categories{?q,max,offset}

Example URI

GET http://api.ticketbis.com/categories/1/categories?q=updated:>2015-03-04T20:00:00Z&max=50&offset=0
URI Parameters
HideShow
id
string (required) Example: 1

Category id.

q
String (optional) Example: updated:>2015-03-04T20:00:00Z

Accepted qualifiers: id, updated.

max
Long (optional) Example: 50

Max items per page.

offset
Long (optional) Example: 0

Current offset.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 68966,
        ...
    },
    {
        "id": 68967,
        ...
    }
]

Sites

Site

Returns a specific site.

Gets a Site
GET/sites/{id}

Example URI

GET http://api.ticketbis.com/sites/1
URI Parameters
HideShow
id
string (required) Example: 1

Site id.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "ticketbisES",
  "url": "www.ticketbis.com",
  "secure_url": "secure.ticketbis.com",
  "api_url": "secure.ticketbis.com",
  "locale": "es_ES",
  "country": {
    "id": 10,
    "name": "Spain",
    "a2": "ES",
    "timezone": "Europe/Madrid",
    "currency": "EUR"
  }
}

Sites Collection

A Collection of sites.

All Sites
GET/sites{?max,offset}

Example URI

GET http://api.ticketbis.com/sites?max=50&offset=0
URI Parameters
HideShow
max
Long (optional) Example: 50

Max items per page.

offset
Long (optional) Example: 0

Current offset.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 1,
        "name": "ticketbisES",
        "url": "www.ticketbis.com",
        "secure_url": "secure.ticketbis.com",
        "api_url": "secure.ticketbis.com",
        "locale": "es_ES",
        "country": {
            "id": 10,
            "name": "Spain",
            "a2": "ES",
            "timezone": "Europe/Madrid",
            "currency": "EUR"
        }
    },
    {
        ...
    }
]

Venues

Venue

Returns a specific venue.

Gets a Venue
GET/venues/{id}

Example URI

GET http://api.ticketbis.com/venues/1
URI Parameters
HideShow
id
string (required) Example: 1

Venue id.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Estadio de San Mamés",
  "address": "Estadio de San Mamés, Luis Briñas 48013 Bilbao",
  "city": "Bilbao",
  "country": "Spain",
  "country_code": "ES",
  "latitude": 43.2728848,
  "longitude": -2.9713064
}

Venues Collection

A Collection of venues.

All Venues
GET/venues{?max,offset}

Example URI

GET http://api.ticketbis.com/venues?max=50&offset=0
URI Parameters
HideShow
max
Long (optional) Example: 50

Max items per page.

offset
Long (optional) Example: 0

Current offset.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 68966,
        ...
    },
    {
        "id": 68967,
        ...
    }
]

Schemas

Schema

Returns a specific schema.

Gets a Schema
GET/schemas/{id}

Example URI

GET http://api.ticketbis.com/schemas/1
URI Parameters
HideShow
id
string (required) Example: 1

Schema id.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Estadio de San Mamés-esquema fútbol",
  "venue": {
    "id": 1,
    "name": "Estadio de San Mamés",
    "address": "Estadio de San Mamés, Luis Briñas 48013 Bilbao",
    "city": "Bilbao",
    "country": "Spain",
    "country_code": "ES",
    "latitude": 43.2728848,
    "longitude": -2.9713064
  },
  "static_image": null,
  "dynamic_image": "https://d3l13i8idnuwnd.cloudfront.net/map/180.svg",
  "venue_schema_id": 180,
  "general_admission": false
}

Schemas Collection by venue

A Collection of schemas filtered by venue.

Schemas by venue
GET/venues/{id}/schemas{?max,offset}

Example URI

GET http://api.ticketbis.com/venues/1/schemas?max=50&offset=0
URI Parameters
HideShow
id
string (required) Example: 1

Venue id.

max
Long (optional) Example: 50

Max items per page.

offset
Long (optional) Example: 0

Current offset.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 68966,
        ...
    },
    {
        "id": 68967,
        ...
    }
]

Section Groups

Section Group

Returns a specific Section Group.

Gets a Section Group
GET/section_groups/{id}

Example URI

GET http://api.ticketbis.com/section_groups/434285
URI Parameters
HideShow
id
string (required) Example: 434285

Section Group id.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 434285,
  "name": "General Admission",
  "dsl": null,
  "price_section": "G.A.",
  "color": 8,
  "disabled": false,
  "sections": []
}

Section Groups Collection by Event

Returns a collection of section groups filtered by event.

Section Groups by Event
GET/events/{id}/section_groups{?max,offset}

Example URI

GET http://api.ticketbis.com/events/75861/section_groups?max=50&offset=0
URI Parameters
HideShow
id
string (required) Example: 75861

Event id.

max
Long (optional) Example: 50

Max items per page.

offset
Long (optional) Example: 0

Current offset.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "id": 380369,
        ...
    },
    {
        "id": 380370,
        ...
    }
]

Generated by aglio on 08 Jul 2016