Skip to main content
GET
/
api
/
public
/
v1
/
product
/
listing
/
list-by
/
city
cURL
curl --location 'https://www.headout.com/api/public/v1/product/listing/list-by/city?cityCode=LONDON&currencyCode=CAD&language=FR&limit=10&offset=10' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "items": [
    {
      "id": 38590,
      "name": "Arte Museum New York",
      "url": "/arte-museum/arte-museum-new-york-tickets-e-38590/",
      "canonicalUrl": "https://www.headout.com/arte-museum/arte-museum-new-york-tickets-e-38590/",
      "city": {
        "name": "New York",
        "code": "NEW_YORK"
      },
      "image": {
        "url": "https://cdn-imgix.headout.com/media/images/730a2ad2-ed58-42e6-8d34-ba0230dfa735-1762937104217-326622.jpg"
      },
      "neighbourhood": null,
      "primaryCategory": {
        "id": 6614,
        "name": "Arte Museum New York",
        "cityCode": "NEW_YORK",
        "url": "/category/6614"
      },
      "currency": {
        "code": "USD",
        "currencyName": "United States Dollar",
        "symbol": "US$",
        "localSymbol": "$",
        "precision": 2,
        "currency": "USD"
      },
      "startGeolocation": {
        "latitude": 40.74739074707031,
        "longitude": -74.00825500488281
      },
      "ratingCumulative": {
        "avg": 4.7,
        "count": 340
      },
      "pricing": {
        "type": "PER_PERSON",
        "currencyCode": "USD",
        "minimumPrice": {
          "originalPrice": 48.99,
          "finalPrice": 48.99
        },
        "bestDiscount": 0
      },
      "hasInstantConfirmation": false,
      "inventorySelectionType": "NORMAL"
    }
  ],
  "nextUrl": "https://www.headout.com/api/public/v1/product/listing/list-by/city?cityCode=NEW_YORK&currencyCode=USD&language=EN&offset=1&limit=1",
  "prevUrl": null,
  "total": 165,
  "nextOffset": 1
}

Authorizations

​
Headout-Auth
string
header
required

Query Parameters

​
cityCode
string
required

City code to list product listings for.

​
currencyCode
string

Currency code for product pricing.

​
language
enum<string>
default:EN

Language code for localization. Content falls back to English when a translation is unavailable.

Available options:
EN,
ES,
FR,
IT,
DE,
PT,
NL,
PL,
KO,
JA,
ZH_HANS,
ZH_HANT,
AR,
DA,
NO,
RO,
RU,
SV,
TR
Example:

"EN"

​
offset
integer
default:0

Number of items to skip before starting to collect the result set.

​
limit
integer
default:10

Maximum number of items to return.

Response

200 - application/json

Successful response

​
items
object[]

The product listings in this page of results.

​
nextUrl
string

Full URL to fetch the next page of results. Null if on the last page.

​
prevUrl
string

Full URL to fetch the previous page of results. Null if on the first page.

​
total
integer

Total number of products matching the query across all pages.

​
nextOffset
integer

Offset value to use in the next request to retrieve the following page.