# SocialCrawl API: tripadvisor endpoints
# Base URL: https://www.socialcrawl.dev
# Auth: x-api-key header
# Full docs: https://www.socialcrawl.dev/docs/tripadvisor

## GET /v1/tripadvisor/search
Search TripAdvisor businesses & places
Credit cost: 1 (standard)
Parameters:
- q (required): Business category, company name, or prominent place (e.g. 'pizza restaurant').
- location (optional, string): Full location name (e.g. 'New York,New York,United States'). Default: United States. Results are location-bound.
- language (optional, string): Optional language code to narrow results, e.g. 'en'.
- depth (optional, integer): Number of results to retrieve (multiples of 30, default 30, max 60 on this synchronous endpoint).
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/search" \
  --data-urlencode "q=pizza restaurant" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/reviews
Get TripAdvisor reviews for a place
Credit cost: 1-5 (metered): 1 credit per page. The default labels (sentiment, issue) are free. label=reports, incentivized or injection holds 4 extra credits and refunds down to 1 credit per started 25 reviews that were newly judged (the first 100 reviews of a page are judged): reviews already labelled are free, a page where nothing could be judged refunds the whole extra, and a cached page is free.
Parameters:
- url_path (required): The TripAdvisor `url_path` of the place (from a search result), e.g. 'Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html'.
- depth (optional, integer): Number of reviews to retrieve (multiples of 10, default 10, max 30 on this synchronous endpoint).
- sort_by (optional, enum: most_recent | detailed_reviews): Review ordering: `most_recent` or `detailed_reviews`.
- rating (optional, enum: excellent | very_good | average | poor | terrible): Filter by traveler rating bucket: excellent | very_good | average | poor | terrible.
- visit_type (optional, enum: families | couples | solo | business | friends): Filter by traveler type: families | couples | solo | business | friends.
- search_reviews_keyword (optional, string): Only return reviews containing this keyword.
- translate (optional, boolean): Translate reviews to the place's domain language (default true). The `translated` flag + `original_language` are always returned.
- label (optional, string): Optional CSV of SocialCrawl labels to add to every review. Without this param every page already carries sentiment and issue, free; label= adds the labels you name to them (the defaults keep running). sentiment and issue are free when asked for too; reports, incentivized and injection add 1 credit per started 25 newly judged reviews. judgments=off (or label=none) turns the default labels off. They read the review's title and text, never its stars. sentiment: how the reviewer feels, on five levels (level 0 to 4, score_0_1, confidence), plus rating_mismatch, true when the words clearly contradict the star rating (a glowing text under 1 star, a furious one under 5), null when the review has no rating. issue: the main problem the review reports (label: product_defect, sizing_or_fit, shipping_or_delivery, customer_service, price_or_value, missing_feature, other, or none, with confidence; label is null when unsure). reports (needs reports=): does this review say that the thing you describe happened (p, 0 to 1). incentivized: does the reviewer say they got the product free, discounted or rewarded for the review (p), and did the text carry a disclosure such as 'in exchange for my honest review', Vine or 체험단 (disclosed). injection flags text that addresses an AI system and tries to direct it (flagged, p); it never drops or rewrites a row. These are signals to read, never a verdict on a review or a reviewer. A review that could not be judged carries labels: null. Reviews already labelled for anyone are free, and so is a cached page. data.labels reports what was judged and billed.
- reports (optional, string): Required by label=reports, ignored otherwise. What to look for, in plain words, up to 300 characters, for example reports=the battery drains quickly or reports=배송이 늦음. Every review gains labels.reports.p, the probability that it says so, in any wording or language. Without it label=reports is skipped with the warning label_reports_needs_reports and is not billed.
- judgments (optional, enum: on | off): Optional, on (the default) or off. By default every row gains free SocialCrawl judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.
- dry_run (optional, enum: 1): Optional. When 1, return a cost preview for this labelled or relevance-filtered request without fetching the page or judging any row. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.
- label_evidence (optional, enum: 1): Optional, only with label=. When 1, every labelled row also carries computed.labels_evidence.<preset> = { quote, sentence_index }: the sentence in the row that most clearly shows the label, copied verbatim. Absent or null when no single sentence shows it.
- fit (optional, enum: goal): Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache at no extra charge. Without this param the page is unchanged.
- goal (optional, string): Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.
- fit_tokens (optional, integer): Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off the page, and the page that reaches one ends the walk: `next_cursor` is not returned and `pagination.stopped_at` is `since`. Sending it sets the newest-first sort shown in this endpoint's sort parameter (any other sort value is a free 400). The page still costs what a page costs, so you pay for the pages you walk and no more. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
Worth sending:
- label=issue: Names the product issue each review raises, at no extra credits; sentiment is free too.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/reviews" \
  --data-urlencode "url_path=Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html" \
  --data-urlencode "label=issue" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/place
Get a TripAdvisor place by URL
Credit cost: 1 (standard)
Parameters:
- url_path (required): The TripAdvisor `url_path` of the place (from a search result), or a full TripAdvisor page URL.
- language (optional, string): Optional locale for the response, e.g. 'en_US'.
- currency (optional, string): Optional 3-letter currency code for price fields, e.g. 'USD'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/place" \
  --data-urlencode "url_path=Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/autocomplete
Autocomplete TripAdvisor places
Credit cost: 1 (standard)
Parameters:
- q (required): Destination, place, hotel, restaurant, or attraction name, e.g. 'Paris'.
- depth (optional, integer): Number of suggestions to return (default 10, max 50).
- language (optional, string): Optional locale, e.g. 'en-US'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/autocomplete" \
  --data-urlencode "q=Paris" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/hotels
Search TripAdvisor hotels
Credit cost: 1 (standard)
Parameters:
- q (required): City, region, or destination, e.g. 'Paris'.
- depth (optional, integer): Number of hotels to retrieve (default 30, max 100).
- sort_by (optional, enum: BEST_VALUE | RANKED | PRICE_LOW_TO_HIGH | DISTANCE): Ordering: BEST_VALUE | RANKED | PRICE_LOW_TO_HIGH | DISTANCE.
- price_min (optional, integer): Minimum nightly price. Omit for no minimum.
- price_max (optional, integer): Maximum nightly price. Omit for no maximum.
- star_rating_min (optional, enum: any | 0 | 1 | 2 | 3 | 4 | 5): Minimum hotel class: any | 0 | 1 | 2 | 3 | 4 | 5.
- review_score_min (optional, enum: any | 3 | 3.5 | 4 | 4.5 | 5): Minimum guest rating: any | 3 | 3.5 | 4 | 4.5 | 5.
- property_type (optional, enum: any | hotel | resort | apartment | villa | hostel | guest_house | bed_and_breakfast): Property type: any | hotel | resort | apartment | villa | hostel | guest_house | bed_and_breakfast.
- currency (optional, string): Optional 3-letter currency code, e.g. 'USD'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/hotels" \
  --data-urlencode "q=Paris" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/hotel
Get a TripAdvisor hotel
Credit cost: 1 (standard)
Parameters:
- url_path (required): The TripAdvisor `url_path` of the hotel, or a full TripAdvisor hotel URL.
- language (optional, string): Optional locale for the response, e.g. 'en_US'.
- currency (optional, string): Optional 3-letter currency code for price fields, e.g. 'USD'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/hotel" \
  --data-urlencode "url_path=Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/restaurants
Search TripAdvisor restaurants
Credit cost: 1 (standard)
Parameters:
- q (required): City, region, or destination, e.g. 'Paris'.
- depth (optional, integer): Number of restaurants to retrieve (default 30, max 100).
- cuisine (optional, enum: any | local | italian | french | indian | chinese | japanese | mexican | seafood | steakhouse | cafe | fast_food): Cuisine filter: any | local | italian | french | indian | chinese | japanese | mexican | seafood | steakhouse | cafe | fast_food.
- meal_type (optional, enum: any | breakfast | lunch | dinner | brunch): Meal filter: any | breakfast | lunch | dinner | brunch.
- price_level (optional, enum: any | cheap | moderate | expensive | fine_dining): Price band: any | cheap | moderate | expensive | fine_dining.
- dietary_restriction (optional, enum: any | vegetarian | vegan | gluten_free | halal | kosher): Dietary filter: any | vegetarian | vegan | gluten_free | halal | kosher.
- open_now (optional, boolean): Only return restaurants currently marked open.
- online_reservations (optional, boolean): Only return restaurants that accept online reservations.
- language (optional, string): Optional locale, e.g. 'en-US'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/restaurants" \
  --data-urlencode "q=Paris" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/restaurant
Get a TripAdvisor restaurant
Credit cost: 1 (standard)
Parameters:
- url_path (required): The TripAdvisor `url_path` of the restaurant, or a full TripAdvisor restaurant URL.
- language (optional, string): Optional locale for the response, e.g. 'en_US'.
- currency (optional, string): Optional 3-letter currency code for price fields, e.g. 'USD'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/restaurant" \
  --data-urlencode "url_path=Restaurant_Review-g187147-d14039269-Reviews-Can_Alegria_Paris-Paris_Ile_de_France.html" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/restaurant/reviews
Get TripAdvisor reviews for a restaurant
Credit cost: 1-5 (metered): 1 credit per page. The default labels (sentiment, issue) are free. label=reports, incentivized or injection holds 4 extra credits and refunds down to 1 credit per started 25 reviews that were newly judged (the first 100 reviews of a page are judged): reviews already labelled are free, a page where nothing could be judged refunds the whole extra, and a cached page is free.
Parameters:
- url_path (required): The TripAdvisor `url_path` of the restaurant, or a full TripAdvisor restaurant URL.
- depth (optional, integer): Number of reviews to retrieve (default 20, max 40).
- language (optional, string): Review language code, e.g. 'en'.
- label (optional, string): Optional CSV of SocialCrawl labels to add to every review. Without this param every page already carries sentiment and issue, free; label= adds the labels you name to them (the defaults keep running). sentiment and issue are free when asked for too; reports, incentivized and injection add 1 credit per started 25 newly judged reviews. judgments=off (or label=none) turns the default labels off. They read the review's title and text, never its stars. sentiment: how the reviewer feels, on five levels (level 0 to 4, score_0_1, confidence), plus rating_mismatch, true when the words clearly contradict the star rating (a glowing text under 1 star, a furious one under 5), null when the review has no rating. issue: the main problem the review reports (label: product_defect, sizing_or_fit, shipping_or_delivery, customer_service, price_or_value, missing_feature, other, or none, with confidence; label is null when unsure). reports (needs reports=): does this review say that the thing you describe happened (p, 0 to 1). incentivized: does the reviewer say they got the product free, discounted or rewarded for the review (p), and did the text carry a disclosure such as 'in exchange for my honest review', Vine or 체험단 (disclosed). injection flags text that addresses an AI system and tries to direct it (flagged, p); it never drops or rewrites a row. These are signals to read, never a verdict on a review or a reviewer. A review that could not be judged carries labels: null. Reviews already labelled for anyone are free, and so is a cached page. data.labels reports what was judged and billed.
- reports (optional, string): Required by label=reports, ignored otherwise. What to look for, in plain words, up to 300 characters, for example reports=the battery drains quickly or reports=배송이 늦음. Every review gains labels.reports.p, the probability that it says so, in any wording or language. Without it label=reports is skipped with the warning label_reports_needs_reports and is not billed.
- judgments (optional, enum: on | off): Optional, on (the default) or off. By default every row gains free SocialCrawl judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.
- dry_run (optional, enum: 1): Optional. When 1, return a cost preview for this labelled or relevance-filtered request without fetching the page or judging any row. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.
- label_evidence (optional, enum: 1): Optional, only with label=. When 1, every labelled row also carries computed.labels_evidence.<preset> = { quote, sentence_index }: the sentence in the row that most clearly shows the label, copied verbatim. Absent or null when no single sentence shows it.
- fit (optional, enum: goal): Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache at no extra charge. Without this param the page is unchanged.
- goal (optional, string): Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.
- fit_tokens (optional, integer): Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
Worth sending:
- label=issue: Names the product issue each review raises, at no extra credits; sentiment is free too.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/restaurant/reviews" \
  --data-urlencode "url_path=Restaurant_Review-g187147-d14039269-Reviews-Can_Alegria_Paris-Paris_Ile_de_France.html" \
  --data-urlencode "label=issue" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/attractions
Search TripAdvisor attractions and things to do
Credit cost: 1 (standard)
Parameters:
- q (required): City, region, or destination, e.g. 'Bangkok'.
- depth (optional, integer): Number of attractions to retrieve (default 30, max 100).
- category (optional, enum: any | attractions | tours | outdoor_activities | museums | shopping | nightlife | spas | classes_workshops): Category: any | attractions | tours | outdoor_activities | museums | shopping | nightlife | spas | classes_workshops.
- duration (optional, enum: any | lt_1_hour | 1_to_4_hours | 4_hours_to_1_day | multi_day): Activity duration: any | lt_1_hour | 1_to_4_hours | 4_hours_to_1_day | multi_day.
- traveler_rating (optional, enum: any | 3 | 3.5 | 4 | 4.5 | 5): Minimum traveler rating: any | 3 | 3.5 | 4 | 4.5 | 5.
- free_cancellation (optional, boolean): Only return activities with free cancellation.
- skip_the_line (optional, boolean): Only return skip-the-line activities.
- private_tour (optional, boolean): Only return private tours.
- currency (optional, string): Optional 3-letter currency code, e.g. 'USD'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/attractions" \
  --data-urlencode "q=Bangkok" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/attraction
Get a TripAdvisor attraction
Credit cost: 1 (standard)
Parameters:
- url_path (required): The TripAdvisor `url_path` of the attraction, or a full TripAdvisor attraction URL.
- language (optional, string): Optional locale for the response, e.g. 'en_US'.
- currency (optional, string): Optional 3-letter currency code for price fields, e.g. 'USD'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/attraction" \
  --data-urlencode "url_path=Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/attraction/reviews
Get TripAdvisor reviews for an attraction
Credit cost: 1-5 (metered): 1 credit per page. The default labels (sentiment, issue) are free. label=reports, incentivized or injection holds 4 extra credits and refunds down to 1 credit per started 25 reviews that were newly judged (the first 100 reviews of a page are judged): reviews already labelled are free, a page where nothing could be judged refunds the whole extra, and a cached page is free.
Parameters:
- url_path (required): The TripAdvisor `url_path` of the attraction, or a full TripAdvisor attraction URL.
- depth (optional, integer): Number of reviews to retrieve (default 20, max 40).
- language (optional, string): Review language code, e.g. 'en'.
- label (optional, string): Optional CSV of SocialCrawl labels to add to every review. Without this param every page already carries sentiment and issue, free; label= adds the labels you name to them (the defaults keep running). sentiment and issue are free when asked for too; reports, incentivized and injection add 1 credit per started 25 newly judged reviews. judgments=off (or label=none) turns the default labels off. They read the review's title and text, never its stars. sentiment: how the reviewer feels, on five levels (level 0 to 4, score_0_1, confidence), plus rating_mismatch, true when the words clearly contradict the star rating (a glowing text under 1 star, a furious one under 5), null when the review has no rating. issue: the main problem the review reports (label: product_defect, sizing_or_fit, shipping_or_delivery, customer_service, price_or_value, missing_feature, other, or none, with confidence; label is null when unsure). reports (needs reports=): does this review say that the thing you describe happened (p, 0 to 1). incentivized: does the reviewer say they got the product free, discounted or rewarded for the review (p), and did the text carry a disclosure such as 'in exchange for my honest review', Vine or 체험단 (disclosed). injection flags text that addresses an AI system and tries to direct it (flagged, p); it never drops or rewrites a row. These are signals to read, never a verdict on a review or a reviewer. A review that could not be judged carries labels: null. Reviews already labelled for anyone are free, and so is a cached page. data.labels reports what was judged and billed.
- reports (optional, string): Required by label=reports, ignored otherwise. What to look for, in plain words, up to 300 characters, for example reports=the battery drains quickly or reports=배송이 늦음. Every review gains labels.reports.p, the probability that it says so, in any wording or language. Without it label=reports is skipped with the warning label_reports_needs_reports and is not billed.
- judgments (optional, enum: on | off): Optional, on (the default) or off. By default every row gains free SocialCrawl judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.
- dry_run (optional, enum: 1): Optional. When 1, return a cost preview for this labelled or relevance-filtered request without fetching the page or judging any row. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.
- label_evidence (optional, enum: 1): Optional, only with label=. When 1, every labelled row also carries computed.labels_evidence.<preset> = { quote, sentence_index }: the sentence in the row that most clearly shows the label, copied verbatim. Absent or null when no single sentence shows it.
- fit (optional, enum: goal): Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache at no extra charge. Without this param the page is unchanged.
- goal (optional, string): Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.
- fit_tokens (optional, integer): Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
Worth sending:
- label=issue: Names the product issue each review raises, at no extra credits; sentiment is free too.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/attraction/reviews" \
  --data-urlencode "url_path=Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html" \
  --data-urlencode "label=issue" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/experience-types
List TripAdvisor experience types for a destination
Credit cost: 1 (standard)
Parameters:
- query (required): City, region, or destination, e.g. 'Bangkok'.
- currency (optional, string): Optional 3-letter currency code, e.g. 'USD'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/experience-types" \
  --data-urlencode "query=Bangkok" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/cruises
Search TripAdvisor cruises
Credit cost: 1 (standard)
Parameters:
- q (required): Cruise destination, e.g. 'Caribbean'.
- depth (optional, integer): Number of sailings to retrieve (default 20, max 100).
- departure_month (optional, string): Departure month in YYYY-MM format, e.g. '2026-07'.
- cabin_type (optional, enum: any | inside | oceanview | balcony | suite): Cabin type: any | inside | oceanview | balcony | suite.
- length (optional, enum: any | 1-2 | 3-5 | 6-9 | 10-14 | 15+): Trip length in nights: any | 1-2 | 3-5 | 6-9 | 10-14 | 15+.
- currency (optional, string): Optional 3-letter currency code, e.g. 'USD'.
- language (optional, string): Optional locale, e.g. 'en_US'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/cruises" \
  --data-urlencode "q=Caribbean" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/cruise
Get a TripAdvisor cruise ship
Credit cost: 1 (standard)
Parameters:
- url_path (required): The TripAdvisor cruise `url_path`, or a full TripAdvisor cruise URL.
- language (optional, string): Optional locale for the response, e.g. 'en_US'.
- currency (optional, string): Optional 3-letter currency code, e.g. 'USD'.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/cruise" \
  --data-urlencode "url_path=Cruise_Review-d15691642-Reviews-MSC_Seaside" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/tripadvisor/cruise/reviews
Get TripAdvisor reviews for a cruise ship
Credit cost: 1-5 (metered): 1 credit per page. The default labels (sentiment, issue) are free. label=reports, incentivized or injection holds 4 extra credits and refunds down to 1 credit per started 25 reviews that were newly judged (the first 100 reviews of a page are judged): reviews already labelled are free, a page where nothing could be judged refunds the whole extra, and a cached page is free.
Parameters:
- url_path (required): The TripAdvisor cruise `url_path`, or a full TripAdvisor cruise URL.
- depth (optional, integer): Number of reviews to retrieve (default 20, max 40).
- language (optional, string): Review language code, e.g. 'en'.
- label (optional, string): Optional CSV of SocialCrawl labels to add to every review. Without this param every page already carries sentiment and issue, free; label= adds the labels you name to them (the defaults keep running). sentiment and issue are free when asked for too; reports, incentivized and injection add 1 credit per started 25 newly judged reviews. judgments=off (or label=none) turns the default labels off. They read the review's title and text, never its stars. sentiment: how the reviewer feels, on five levels (level 0 to 4, score_0_1, confidence), plus rating_mismatch, true when the words clearly contradict the star rating (a glowing text under 1 star, a furious one under 5), null when the review has no rating. issue: the main problem the review reports (label: product_defect, sizing_or_fit, shipping_or_delivery, customer_service, price_or_value, missing_feature, other, or none, with confidence; label is null when unsure). reports (needs reports=): does this review say that the thing you describe happened (p, 0 to 1). incentivized: does the reviewer say they got the product free, discounted or rewarded for the review (p), and did the text carry a disclosure such as 'in exchange for my honest review', Vine or 체험단 (disclosed). injection flags text that addresses an AI system and tries to direct it (flagged, p); it never drops or rewrites a row. These are signals to read, never a verdict on a review or a reviewer. A review that could not be judged carries labels: null. Reviews already labelled for anyone are free, and so is a cached page. data.labels reports what was judged and billed.
- reports (optional, string): Required by label=reports, ignored otherwise. What to look for, in plain words, up to 300 characters, for example reports=the battery drains quickly or reports=배송이 늦음. Every review gains labels.reports.p, the probability that it says so, in any wording or language. Without it label=reports is skipped with the warning label_reports_needs_reports and is not billed.
- judgments (optional, enum: on | off): Optional, on (the default) or off. By default every row gains free SocialCrawl judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.
- dry_run (optional, enum: 1): Optional. When 1, return a cost preview for this labelled or relevance-filtered request without fetching the page or judging any row. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.
- label_evidence (optional, enum: 1): Optional, only with label=. When 1, every labelled row also carries computed.labels_evidence.<preset> = { quote, sentence_index }: the sentence in the row that most clearly shows the label, copied verbatim. Absent or null when no single sentence shows it.
- fit (optional, enum: goal): Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache at no extra charge. Without this param the page is unchanged.
- goal (optional, string): Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.
- fit_tokens (optional, integer): Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
Worth sending:
- label=issue: Names the product issue each review raises, at no extra credits; sentiment is free too.
curl -G "https://www.socialcrawl.dev/v1/tripadvisor/cruise/reviews" \
  --data-urlencode "url_path=Cruise_Review-d15691642-Reviews-MSC_Seaside" \
  --data-urlencode "label=issue" \
  -H "x-api-key: YOUR_API_KEY"