API

Every tripadvisor.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Catalog

locationsNearby

catalog.locationsNearby Search nearby Tripadvisor catalog locations by coordinates or location ID Risk: read

await corsair.tripadvisor.api.catalog.locationsNearby({});

Input

Name	Type	Required	Description
`location_id`	`string`	No	—
`lat`	`number`	No	—
`lon`	`number`	No	—
`radius`	`number`	No	—
`unit`	`MI \| KM`	No	—
`sw_lat`	`number`	No	—
`sw_lon`	`number`	No	—
`ne_lat`	`number`	No	—
`ne_lon`	`number`	No	—
`category`	`RESTAURANT \| ATTRACTION \| HOTEL`	No	—
`min_rating`	`number`	No	—
`locale`	`string[]`	No	—
`page`	`number`	No	—
`size`	`number`	No	—
`sort`	`string[]`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

data full type

{
  bearing?: number,
  distance_kilometers?: number,
  distance_miles?: number,
  location: {
    addresses?: {
      city?: string,
      country_code?: string,
      country_name?: string,
      formatted?: string,
      language?: string,
      postal_code?: string,
      state?: string,
      street_address?: string,
      street_address2?: string
    }[],
    coordinates?: {
      latitude: number,
      longitude: number
    },
    descriptions: {
      language: string,
      value: string
    }[],
    geo: string,
    geo_id: number,
    id: number,
    names: {
      language: string,
      value: string,
      primary?: boolean
    }[],
    overall_rating?: {
      count?: number,
      icon_url?: string,
      rating?: number
    },
    urls?: {
      android_intent?: string,
      menu?: string,
      official?: string,
      tripadvisor?: {
        main?: string,
        photos?: string,
        questions_answers?: string,
        write_review?: string
      }
    }
  }
}[]

pagination full type

{
  page?: number,
  size?: number,
  total_elements?: number,
  total_pages?: number
}

Geo

details

geo.details Get factual and hierarchy details for a Tripadvisor geo Risk: read

await corsair.tripadvisor.api.geo.details({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`locale`	`string[]`	No	—

Output

Name	Type	Required	Description
`abbreviation`	`string`	No	—
`awards`	`object[]`	No	—
`collections`	`object[]`	No	—
`coordinates`	`object`	No	—
`descriptions`	`object[]`	Yes	—
`forum_faqs`	`object[]`	No	—
`hierarchy`	`object`	No	—
`id`	`number`	Yes	—
`names`	`object[]`	Yes	—
`suggested_itineraries`	`object[]`	No	—
`type`	`object`	Yes	—
`urls`	`object`	No	—

awards full type

{
  category?: string,
  geo?: string,
  image?: {
    key?: string,
    url?: string
  },
  name?: string,
  type?: Certificate of Excellence | Travelers' Choice,
  year?: number
}[]

collections full type

{
  id?: string,
  title?: string,
  url?: string
}[]

coordinates full type

{
  latitude: number,
  longitude: number
}

descriptions full type

{
  language: string,
  value: string
}[]

forum_faqs full type

{
  answers?: {
    text?: string,
    title?: string
  }[],
  language?: string,
  question?: string
}[]

hierarchy full type

{
  ancestors?: {
    geo_id?: number,
    name?: string,
    rank?: number
  }[]
}

names full type

{
  language: string,
  value: string,
  primary?: boolean
}[]

suggested_itineraries full type

{
  itinerary?: {
    day?: number,
    description?: string,
    location_ids?: {
      id?: number,
      rank?: number
    }[]
  }[],
  trip_creation_method?: string,
  trip_id?: number,
  trip_interest_tags?: string[],
  trip_title?: string,
  trip_url?: string
}[]

type full type

{
  id: number,
  name: string
}

urls full type

{
  flights?: string,
  geo_page?: string,
  hotels?: string,
  restaurants?: string,
  things_to_do?: string
}

Location

details

location.details Get full details, ratings, rankings and awards for a Tripadvisor location Risk: read

await corsair.tripadvisor.api.location.details({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`locale`	`string[]`	No	—

Output

Name	Type	Required	Description
`accommodation`	`object`	No	—
`addresses`	`object[]`	No	—
`attributes`	`object[]`	No	—
`awards`	`object[]`	No	—
`categories`	`object[]`	No	—
`coordinates`	`object`	No	—
`descriptions`	`object[]`	Yes	—
`geo`	`string`	Yes	—
`geo_id`	`number`	Yes	—
`id`	`number`	Yes	—
`names`	`object[]`	Yes	—
`neighborhoods`	`object[]`	No	—
`official_email`	`string`	No	—
`opening_hours`	`object`	No	—
`phone_numbers`	`object[]`	No	—
`photos`	`object`	Yes	—
`price_level`	`string`	No	—
`rankings`	`object[]`	No	—
`recommended_visit_length`	`number`	No	—
`status`	`object`	Yes	—
`traveler_ratings`	`object`	No	—
`urls`	`object`	No	—

accommodation full type

{
  brand?: string,
  chain?: string,
  prices?: {
    currency?: string,
    max_rate?: number,
    min_rate?: number
  }[],
  room_count?: number,
  star_rating?: number
}

addresses full type

{
  city?: string,
  country_code?: string,
  country_name?: string,
  formatted?: string,
  language?: string,
  postal_code?: string,
  state?: string,
  street_address?: string,
  street_address2?: string
}[]

attributes full type

{
  id?: string,
  name?: string,
  type?: string,
  type_id?: string
}[]

awards full type

{
  category?: string,
  geo?: string,
  image?: {
    key?: string,
    url?: string
  },
  name?: string,
  type?: Certificate of Excellence | Travelers' Choice,
  year?: number
}[]

categories full type

{
  display_name?: string,
  hierarchy?: string,
  id: string,
  parent_category?: {
    display_name?: string,
    id?: string,
    parent_category?: {
    }
  },
  top_level_category?: Accommodation | Experience | Attraction | Eat & Drink
}[]

coordinates full type

{
  latitude: number,
  longitude: number
}

descriptions full type

{
  language: string,
  value: string
}[]

names full type

{
  language: string,
  value: string,
  primary?: boolean
}[]

neighborhoods full type

{
  geo_id?: string,
  name?: string
}[]

opening_hours full type

{
  formatted?: string[],
  periods?: {
    closes?: string,
    day_of_week?: Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday,
    opens?: string
  }[],
  timezone?: string
}

phone_numbers full type

{
  type: string,
  value: string
}[]

photos full type

{
  total_count?: number
}

rankings full type

{
  category?: string,
  category_id?: string,
  display_text?: string,
  geo?: string,
  geo_id?: number,
  rank?: number,
  total?: number
}[]

status full type

{
  closed_date?: string,
  reopen_date?: string,
  value: OPEN | CLOSED | TEMPORARILY_CLOSED
}

traveler_ratings full type

{
  breakdowns?: {
    count?: number,
    rating?: number,
    rating_name?: string
  }[],
  language_counts?: {
    count?: number,
    language?: string
  }[],
  overall?: {
    count?: number,
    icon_url?: string,
    rating?: number
  },
  subratings?: {
    count?: number,
    icon_url?: string,
    rating?: number,
    type?: string,
    type_name?: string
  }[]
}

urls full type

{
  android_intent?: string,
  menu?: string,
  official?: string,
  tripadvisor?: {
    main?: string,
    photos?: string,
    questions_answers?: string,
    write_review?: string
  }
}

photos

location.photos Get photos for a Tripadvisor location Risk: read

await corsair.tripadvisor.api.location.photos({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`locale`	`string[]`	No	—
`page`	`number`	No	—
`size`	`number`	No	—
`sort`	`string[]`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

data full type

{
  caption?: string,
  cv_metadata?: {
    attractiveness_score?: number,
    scene?: string
  },
  id: number,
  location_id: number,
  photo: {
    key?: string,
    media_type?: string,
    original_height?: number,
    original_size_url?: string,
    original_width?: number
  },
  publish_ts: string,
  source: {
    name: Management | Traveler
  },
  user?: {
    avatar_url?: {
      key?: string,
      url?: string
    },
    geo?: string,
    geo_id?: number,
    username?: string
  }
}[]

pagination full type

{
  page?: number,
  size?: number,
  total_elements?: number,
  total_pages?: number
}

reviews

location.reviews Get traveler reviews for a Tripadvisor location Risk: read

await corsair.tripadvisor.api.location.reviews({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`rating_min`	`number`	No	—
`trip_type`	`string`	No	—
`published_after_ts`	`string`	No	—
`sort_by`	`MOST_RECENT \| HIGHEST_RATED`	No	—
`published_after_review_id`	`string`	No	—
`language`	`string`	No	—
`page`	`number`	No	—
`size`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

data full type

{
  id: number,
  owner_response?: {
    author_connection?: string,
    avatar_url?: {
      key?: string,
      url?: string
    },
    geo_id?: number,
    id?: number,
    publish_date?: string,
    text?: {
      language: string,
      value: string,
      primary?: boolean
    }[],
    username?: string
  },
  photos?: {
    key?: string,
    media_type?: string,
    original_height?: number,
    original_size_url?: string,
    original_width?: number
  }[],
  publish_ts: string,
  rating: number,
  rating_icon_url?: {
    key?: string,
    url?: string
  },
  subratings: {
    icon_url: {
      key?: string,
      url?: string
    },
    rating: number,
    type: string,
    type_name: string
  }[],
  text: {
    language: string,
    value: string,
    primary?: boolean
  }[],
  title: {
    language: string,
    value: string,
    primary?: boolean
  }[],
  travel_date: string,
  trip_type: BUSINESS | COUPLES | FAMILY | FRIENDS | SOLO | NONE,
  url?: string,
  user?: {
    avatar_url?: {
      key?: string,
      url?: string
    },
    geo?: string,
    geo_id?: number,
    username?: string
  }
}[]

pagination full type

{
  page?: number,
  size?: number,
  total_elements?: number,
  total_pages?: number
}

Locations

nearby

locations.nearby Find full location representations near an area; filter category HOTEL to list nearby hotels Risk: read

await corsair.tripadvisor.api.locations.nearby({});

Input

Name	Type	Required	Description
`location_id`	`string`	No	—
`lat`	`number`	No	—
`lon`	`number`	No	—
`radius`	`number`	No	—
`unit`	`MI \| KM`	No	—
`sw_lat`	`number`	No	—
`sw_lon`	`number`	No	—
`ne_lat`	`number`	No	—
`ne_lon`	`number`	No	—
`category`	`RESTAURANT \| ATTRACTION \| HOTEL`	No	—
`min_rating`	`number`	No	—
`locale`	`string[]`	No	—
`page`	`number`	No	—
`size`	`number`	No	—
`sort`	`string[]`	No	—
`include_photo`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	Yes	—

data full type

{
  bearing?: number,
  distance_kilometers?: number,
  distance_miles?: number,
  location: {
    accommodation?: {
      brand?: string,
      chain?: string,
      prices?: {
        currency?: string,
        max_rate?: number,
        min_rate?: number
      }[],
      room_count?: number,
      star_rating?: number
    },
    addresses?: {
      city?: string,
      country_code?: string,
      country_name?: string,
      formatted?: string,
      language?: string,
      postal_code?: string,
      state?: string,
      street_address?: string,
      street_address2?: string
    }[],
    attributes?: {
      id?: string,
      name?: string,
      type?: string,
      type_id?: string
    }[],
    awards?: {
      category?: string,
      geo?: string,
      image?: {
        key?: string,
        url?: string
      },
      name?: string,
      type?: Certificate of Excellence | Travelers' Choice,
      year?: number
    }[],
    categories?: {
      display_name?: string,
      hierarchy?: string,
      id: string,
      parent_category?: {
        display_name?: string,
        id?: string,
        parent_category?: {
        }
      },
      top_level_category?: Accommodation | Experience | Attraction | Eat & Drink
    }[],
    coordinates?: {
      latitude: number,
      longitude: number
    },
    descriptions: {
      language: string,
      value: string
    }[],
    geo: string,
    geo_id: number,
    id: number,
    names: {
      language: string,
      value: string,
      primary?: boolean
    }[],
    neighborhoods?: {
      geo_id?: string,
      name?: string
    }[],
    official_email?: string,
    opening_hours?: {
      formatted?: string[],
      periods?: {
        closes?: string,
        day_of_week?: Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday,
        opens?: string
      }[],
      timezone?: string
    },
    phone_numbers?: {
      type: string,
      value: string
    }[],
    photos: {
      total_count?: number
    },
    price_level?: string,
    rankings?: {
      category?: string,
      category_id?: string,
      display_text?: string,
      geo?: string,
      geo_id?: number,
      rank?: number,
      total?: number
    }[],
    recommended_visit_length?: number,
    status: {
      closed_date?: string,
      reopen_date?: string,
      value: OPEN | CLOSED | TEMPORARILY_CLOSED
    },
    traveler_ratings?: {
      breakdowns?: {
        count?: number,
        rating?: number,
        rating_name?: string
      }[],
      language_counts?: {
        count?: number,
        language?: string
      }[],
      overall?: {
        count?: number,
        icon_url?: string,
        rating?: number
      },
      subratings?: {
        count?: number,
        icon_url?: string,
        rating?: number,
        type?: string,
        type_name?: string
      }[]
    },
    urls?: {
      android_intent?: string,
      menu?: string,
      official?: string,
      tripadvisor?: {
        main?: string,
        photos?: string,
        questions_answers?: string,
        write_review?: string
      }
    }
  },
  photo?: {
    caption?: string,
    cv_metadata?: {
      attractiveness_score?: number,
      scene?: string
    },
    id: number,
    location_id: number,
    photo: {
      key?: string,
      media_type?: string,
      original_height?: number,
      original_size_url?: string,
      original_width?: number
    },
    publish_ts: string,
    source: {
      name: Management | Traveler
    },
    user?: {
      avatar_url?: {
        key?: string,
        url?: string
      },
      geo?: string,
      geo_id?: number,
      username?: string
    }
  }
}[]

pagination full type

{
  page?: number,
  size?: number,
  total_elements?: number,
  total_pages?: number
}

Overview

Plugins

Catalog

locationsNearby

Geo

details

Location

details

photos

reviews

Locations

nearby

​Catalog

​locationsNearby

​Geo

​details

​Location

​details

​photos

​reviews

​Locations

​nearby

Catalog

locationsNearby

Geo

details

Location

details

photos

reviews

Locations

nearby