Skip to content
Docs

Expedia search

Resolve a hotel name to Expedia's numeric property identifier.

POST/v1/ota/expedia/search
2 creditsTry itExpedia API overview →

Add city to disambiguate brands, then store recommended_match.property_id for POST /v1/ota/expedia. It is null when only weak or ambiguous candidates were found. Expedia ids match Hotels.com's for newer properties only.

Request

POSThttps://api.scrapercompany.com/v1/ota/expedia/search

Authenticate with your API key in the x-api-key header (see Authentication).

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Body

JSON object. Unknown fields are rejected with 422.

  • namestringrequiredmin length 1

    Hotel name as a guest would search for it.

  • citystringdefault

    Strongly recommended. Sent with the name to Expedia's search and used to rank same-brand hotels in other cities lower.

  • marketstringdefault US

    Expedia point-of-sale, which is how currency is selected - there is no currency field. US prices in USD on www.expedia.com, CA in CAD on www.expedia.ca. The display basis differs by market (the US room card leads with the stay total, CA with the nightly price), so compare within one market.

    One ofCAUS

  • limitintegerdefault 5min 1, max 10

    Maximum hotel candidates to return, best match first.

Example request

curl -X POST "https://api.scrapercompany.com/v1/ota/expedia/search" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Hilton Chicago",
    "city": "Chicago",
    "market": "US"
  }'

Response

200 — Candidate Expedia numeric property ids, with city-aware ranking. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response
{
  "search_parameters": {
    "engine": "expedia_search",
    "name": "Hilton Chicago",
    "city": "Chicago",
    "market": "US",
    "limit": 5
  },
  "search_status": "matched",
  "recommended_match": {
    "property_id": "12570",
    "name": "Hilton Chicago",
    "city": "Chicago",
    "address": "720 S Michigan Ave, Chicago, IL",
    "country": "USA",
    "url": "https://www.expedia.com/h12570.Hotel-Information",
    "rank": 0,
    "score": 1,
    "name_score": 1,
    "identity_score": 1,
    "match_score": 1,
    "confidence": "high",
    "city_score": 1,
    "winner_reason": "",
    "coordinates": {
      "latitude": 41.872505,
      "longitude": -87.62482
    }
  },
  "warnings": [],
  "matches": [
    {
      "property_id": "12570",
      "name": "Hilton Chicago",
      "city": "Chicago",
      "address": "720 S Michigan Ave, Chicago, IL",
      "country": "USA",
      "url": "https://www.expedia.com/h12570.Hotel-Information",
      "rank": 0,
      "match_score": 1,
      "confidence": "high"
    }
  ],
  "meta": {
    "source": "expedia",
    "matches": 1,
    "selection_method": "name_city_confidence",
    "match_threshold": 0.8,
    "match_margin": 0.12,
    "elapsed_s": 0.31
  }
}

Response fields

Fields marked required are always present; others appear when they apply.

  • search_parametersobjectrequired
    Show 5 child fields
    • search_parameters.enginestringrequired

      One ofexpedia_search

    • search_parameters.namestringrequired
    • search_parameters.citystringrequired
    • search_parameters.marketstringrequired

      Point-of-sale searched: US (www.expedia.com) or CA (www.expedia.ca).

    • search_parameters.limitintegerrequired
  • search_statusstringrequired

    matched only when the top candidate clears the identity threshold and margin.

    One ofmatchedambiguousnot_found

  • recommended_matchobject | nullrequired

    Safe to store; null unless search_status is matched.

    Show 15 child fields
    • recommended_match.property_idstringrequired

      Numeric Expedia id (digits); pass as property_id to POST /v1/ota/expedia or as expedia_property_id to POST /v1/ota/compare. Matches the Hotels.com id only for newer properties.

    • recommended_match.namestringrequired
    • recommended_match.citystringrequired
    • recommended_match.addressstringrequired
    • recommended_match.countrystringrequired
    • recommended_match.urlstringrequired

      Expedia property page, https://<host>/h<property_id>.Hotel-Information.

    • recommended_match.rankintegerrequired
    • recommended_match.scorenumberrequired
    • recommended_match.name_scorenumberrequired
    • recommended_match.identity_scorenumberrequired
    • recommended_match.match_scorenumberrequired
    • recommended_match.confidencestringrequired

      One ofhighmediumlow

    • recommended_match.winner_reasonstringrequired
    • recommended_match.city_scorenumber

      Present only when city was supplied.

    • recommended_match.coordinatesobject

      Present only when the source returned coordinates.

      Show 2 child fields
      • recommended_match.coordinates.latitudenumberrequired
      • recommended_match.coordinates.longitudenumberrequired
  • warningsarray of stringrequired
  • matchesarray of objectrequired

    Candidates, best first, for manual review.

    Show 15 child fields
    • matches[].property_idstringrequired

      Numeric Expedia id (digits); pass as property_id to POST /v1/ota/expedia or as expedia_property_id to POST /v1/ota/compare. Matches the Hotels.com id only for newer properties.

    • matches[].namestringrequired
    • matches[].citystringrequired
    • matches[].addressstringrequired
    • matches[].countrystringrequired
    • matches[].urlstringrequired

      Expedia property page, https://<host>/h<property_id>.Hotel-Information.

    • matches[].rankintegerrequired
    • matches[].scorenumberrequired
    • matches[].name_scorenumberrequired
    • matches[].identity_scorenumberrequired
    • matches[].match_scorenumberrequired
    • matches[].confidencestringrequired

      One ofhighmediumlow

    • matches[].winner_reasonstringrequired
    • matches[].city_scorenumber

      Present only when city was supplied.

    • matches[].coordinatesobject

      Present only when the source returned coordinates.

      Show 2 child fields
      • matches[].coordinates.latitudenumberrequired
      • matches[].coordinates.longitudenumberrequired
  • metaobjectrequired
    Show 6 child fields
    • meta.sourcestringrequired

      One ofexpedia

    • meta.matchesintegerrequired
    • meta.selection_methodstringrequired
    • meta.match_thresholdnumberrequired
    • meta.match_marginnumberrequired
    • meta.elapsed_snumberrequired

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

StatusMeaningRetry?
401Unauthorized

Missing or invalid API key.

{"detail":"missing or invalid API key"}
No, fix the request
402Payment Required

Not enough credits for this request: the account's credits mode is enforce (mode in GET /v1/billing) and the request costs more than the available credits. Nothing is run or charged.

{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}
No, fix the request
422Unprocessable Content

Request validation failed. detail is a list of problems for schema errors, or a string for semantic checks performed by the endpoint.

{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}
No, fix the request
429Too Many Requests

Too many requests: the key's requests-per-minute limit was exceeded, or (in enforce credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry.

{"detail":"rate limit 60/min exceeded"}
Yes, with backoff
502Bad Gateway

The upstream source failed, blocked the request or returned an unusable answer. Safe to retry later; failed requests are not charged.

{"detail":"RuntimeError"}
Yes, with backoff
503Service Unavailable

Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later.

{"detail":"database unavailable: OperationalError"}
Yes, with backoff

Try it

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

  1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
  2. Copy the cURL example above and run it in a terminal.

Credits

2 credits per successful call. Failed, blocked and empty results are free.

Questions about this page?

Send the page link and your question, and the team will answer.

Email support