Ikyu name search API reference

Request

POSThttps://api.scrapercompany.com/v1/ota/ikyu/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, max length 120
Hotel name as a guest would type it. Japanese and Korean sites list most hotels under their local-language name only.
citystringdefault max length 80
City or area, used to rank candidates.
limitintegerdefault 5min 1, max 10
Most candidates returned.

Example request

curl -X POST "https://api.scrapercompany.com/v1/ota/ikyu/search" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ホテルニューオータニ"
  }'

Response

200 — Ikyu hotel numbers for a name. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response

{
  "search_parameters": {
    "engine": "ikyu_search",
    "name": "Hotel New Otani",
    "city": "Tokyo",
    "source": "ikyu",
    "limit": 2
  },
  "search_status": "matched",
  "recommended_match": {
    "hotel_no": "00002130",
    "name": "Hotel New Otani Tokyo",
    "address": "4-1 Kioicho, Chiyoda-ku",
    "area": "3-minute walk from Akasaka-mitsuke Station",
    "prefecture": "Tokyo Metropolis",
    "url": "https://www.ikyu.com/00002130/",
    "match_score": 1,
    "confidence": "high",
    "coordinates": {
      "latitude": 35.681248,
      "longitude": 139.734155
    }
  },
  "warnings": [],
  "matches": [
    {
      "hotel_no": "00002130",
      "name": "Hotel New Otani Tokyo",
      "address": "4-1 Kioicho, Chiyoda-ku",
      "area": "3-minute walk from Akasaka-mitsuke Station",
      "prefecture": "Tokyo Metropolis",
      "url": "https://www.ikyu.com/00002130/",
      "match_score": 1,
      "confidence": "high",
      "coordinates": {
        "latitude": 35.681248,
        "longitude": 139.734155
      }
    },
    {
      "hotel_no": "00000171",
      "name": "Tokyo Dome Hotel",
      "address": "1-3-61 Koraku, Bunkyo-ku",
      "area": "2-minute walk from Suidobashi Station",
      "prefecture": "Tokyo Metropolis",
      "url": "https://www.ikyu.com/00000171/",
      "match_score": 0.2,
      "confidence": "low",
      "coordinates": {
        "latitude": 35.703618,
        "longitude": 139.753517
      }
    }
  ],
  "meta": {
    "source": "ikyu",
    "matches": 2,
    "selection_method": "name_city_confidence",
    "match_threshold": 0.8,
    "match_margin": 0.12,
    "language": "en",
    "requests": 1,
    "elapsed_s": 0.357
  }
}

Errors

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

Status	Meaning	Retry?
`401`Unauthorized	Missing or invalid API key. `{"detail":"missing or invalid API key"}`	No, fix the request
`402`Payment 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
`422`Unprocessable 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
`429`Too 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
`503`Service 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.

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

Credits

1 credit per successful call (1 per lookup (no match and failed requests are free)). Failed, blocked and empty results are free.

Request#

Body#

Example request#

Response#

Errors#

Try it#