Hot Pepper Gourmet API

https://webservice.recruit.co.jp/
Admin
API documentation for accessing Japanese restaurant information from Hot Pepper Gourmet database via...
Tokens:18,475
Snippets:137
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Recommend Shops by Location and Range

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This example shows how to retrieve recommended shops based on specified latitude, longitude, range, and order.

```HTTP
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/?key=[APIキー]&lat=34.67&lng=135.52&range=5&order=4
```

--------------------------------

### Search Shops by Keyword

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Example of searching for shops using keywords like 'organic' and 'Tokyo'.

```http
http://webservice.recruit.co.jp/hotpepper/shop/v1/?key=[APIキー]&keyword=%E3%82%AA%E3%83%BC%E3%82%AC%E3%83%8B%E3%83%83%E3%82%AF%2C%E6%9D%B1%E4%BA%AC
```

--------------------------------

### Specify Search Start Position

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This parameter allows you to specify the starting position for search results, useful for pagination.

```HTTP
start=31
```

--------------------------------

### Search Shops by Keyword

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This example demonstrates how to search for shops using a keyword, which can match shop names, readings, or addresses. Multiple keywords can be specified for AND search.

```HTTP
key=[APIキー]&keyword=渋谷 居酒屋
```

--------------------------------

### API Error Response Example

Source: https://webservice.recruit.co.jp/hotpepper/middle_area/v1?key=sample&middle_area=Y005

This XML structure shows an example of an error response from the Hot Pepper API. It includes the API version, an error code, and a descriptive message.

```xml
<results xmlns="http://webservice.recruit.co.jp/HotPepper/">
<api_version>1.30</api_version>
<error>
<code>2000</code>
<message>このAPIキーはリファレンスページからのみ利用可能です</message>
</error>
</results>
```

--------------------------------

### Sample Shop Response

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

An example XML response for a shop search query, detailing API version, results count, and shop information.

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<results xmlns="http://webservice.recruit.co.jp/HotPepper/">
  <api_version>1.20</api_version>
  <results_available>47</results_available>
  <results_returned>1</results_returned>
  <results_start>1</results_start>
  <shop>
    <id>J000000000</id>
    <name>リクルートカフェ</name>
    <name_kana>りくるーとかふぇ</name_kana>
    <address>東京都中央区新橋</address>
    <genre>
      <name>カフェ・喫茶</name>
    </genre>
    <urls>
      <pc>http://www.hotpepper.jp/...</pc>
    </urls>
    <desc>0</desc>
  </shop>

```

--------------------------------

### Search Dinner Budget Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Example query to search the dinner budget master data. Requires an API key.

```http
http://webservice.recruit.co.jp/hotpepper/budget/v1/?key=[APIキー]
```

--------------------------------

### Search Shops by Location and Order

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This example shows how to search for shops by specifying latitude, longitude, a search range, and an order preference. The API key is mandatory.

```APIDOC
## GET /hotpepper/gourmet/v1/

### Description
Searches for shops based on geographical coordinates, search range, and desired order.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **lat** (number) - Required - The latitude of the search center.
- **lng** (number) - Required - The longitude of the search center.
- **range** (integer) - Required - The search range in kilometers (e.g., 5 km).
- **order** (integer) - Required - The order in which to return results (e.g., 4 for recommendation order).

### Request Example
```
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/?key=[APIキー]&lat=34.67&lng=135.52&range=5&order=4
```

### Response
#### Success Response (200)
(Response fields are the same as the 'Search Shops by Large Area' example, with shop details relevant to the location and order criteria.)

#### Response Example
(Example response structure would be detailed here if provided in source)
```

--------------------------------

### Error Response Example (Missing API Key)

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This XML snippet demonstrates an error response when the API key parameter is missing. Always check the response content for errors, as the HTTP status will be 200 OK.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://webservice.recruit.co.jp/hotpepper/">
  <api_version>1.00</api_version>
  <error>
    <message>keyは必須パラメーターです</message>
    <code>3000</code>
  </error>
</results>
```

--------------------------------

### Search Shops by Large Area

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This example demonstrates how to search for shops within a specific large area, using the `large_area` parameter. The API key is required for all requests.

```APIDOC
## GET /hotpepper/gourmet/v1/

### Description
Searches for shops based on specified criteria, such as large area code.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **large_area** (string) - Required - The code for the large area to search within (e.g., Z011 for Tokyo).

### Request Example
```
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/?key=[APIキー]&large_area=Z011
```

### Response
#### Success Response (200)
- **results** (object) - Contains search results.
- **api_version** (string) - API version.
- **results_available** (integer) - Total number of results matching the query.
- **results_returned** (integer) - Number of results included in this response.
- **results_start** (integer) - The starting position of the search results.
- **shop** (array) - An array of shop objects.
  - **id** (string) - Shop ID.
  - **name** (string) - Shop name.
  - **logo_image** (string) - URL of the logo image.
  - **name_kana** (string) - Shop name in kana.
  - **address** (string) - Shop address.
  - **station_name** (string) - Nearest station name.
  - **ktai_coupon** (integer) - Indicates if mobile coupons are available (0: Yes, 1: No).
  - **large_service_area** (object) - Information about the large service area.
  - **service_area** (object) - Information about the service area.
  - **large_area** (object) - Information about the large area.
  - **middle_area** (object) - Information about the middle area.
  - **small_area** (object) - Information about the small area.
  - **lat** (number) - Latitude.
  - **lng** (number) - Longitude.
  - **genre** (object) - Information about the shop's genre.
  - **budget** (object) - Information about the shop's budget.
  - **catch** (string) - Catchphrase for the shop.
  - **capacity** (integer) - Total seating capacity.
  - **access** (string) - Access information.
  - **mobile_access** (string) - Mobile access information.
  - **urls** (object) - URLs related to the shop.
  - **open** (string) - Opening hours.
  - **close** (string) - Closing days.
  - **party_capacity** (integer) - Maximum party capacity.
  - **wifi** (string) - WiFi availability.
  - **wedding** (string) - Wedding/second party information.
  - **course** (string) - Course availability.
  - **free_drink** (string) - Free drink availability.
  - **free_food** (string) - Free food availability.
  - **private_room** (string) - Private room availability.
  - **horigotatsu** (string) - Horigotatsu availability.
  - **tatami** (string) - Tatami room availability.
  - **card** (string) - Card payment availability.
  - **non_smoking** (string) - Non-smoking seating availability.
  - **charter** (string) - Charter availability.
  - **ktai** (string) - Mobile phone reception status.
  - **parking** (string) - Parking availability.
  - **barrier_free** (string) - Barrier-free access.
  - **other_memo** (string) - Other facility information.
  - **sommelier** (string) - Sommelier availability.
  - **open_air** (string) - Open air seating availability.
  - **show** (string) - Show/live performance availability.
  - **equipment** (string) - Entertainment equipment.
  - **karaoke** (string) - Karaoke availability.
  - **band** (string) - Live band availability.
  - **tv** (string) - TV/projector availability.
  - **english** (string) - English menu availability.
  - **pet** (string) - Pet-friendliness.
  - **child** (string) - Child-friendliness.
  - **lunch** (string) - Lunch availability.
  - **midnight** (string) - Late-night operation.
  - **shop_detail_memo** (string) - Shop detail memo.
  - **coupon_urls** (object) - URLs for coupons.

#### Response Example
(Example response structure would be detailed here if provided in source)
```

--------------------------------

### Search Service Area Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Example query to search the service area master data. Requires an API key.

```http
http://webservice.recruit.co.jp/hotpepper/service_area/v1/?key=[APIキー]
```

--------------------------------

### Search Shops

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This section details the general search query parameters for the shop API, including keyword, telephone number, start position, count, and format.

```APIDOC
## GET /hotpepper/shop/v1/

### Description
Provides general search capabilities for shops using various query parameters.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/shop/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **keyword** (string) - Optional - Search by shop name, kana, or address (partial match). Supports AND search with space-separated strings. Multiple keywords can be specified.
- **tel** (string) - Optional - Search by shop's phone number (exact match). Use digits only (no hyphens).
- **start** (integer) - Optional - The starting position for the search results. Defaults to 1.
- **count** (integer) - Optional - The maximum number of results to return per page. Defaults to 30, minimum 1, maximum 30.
- **format** (string) - Optional - The desired response format. Options are 'xml' or 'json'. Defaults to 'xml'.

### Request Example
```
http://webservice.recruit.co.jp/hotpepper/shop/v1/?key=[APIキー]&keyword=居酒屋 東京&format=json
```

### Response
#### Success Response (200)
(Response fields are similar to the gourmet search, detailing shop information based on the provided query parameters.)

#### Response Example
(Example response structure would be detailed here if provided in source)
```

--------------------------------

### Search Large Service Area Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Example query to search the large service area master data. Requires an API key.

```http
http://webservice.recruit.co.jp/hotpepper/large_service_area/v1/?key=[APIキー]
```

--------------------------------

### Hot Pepper Small Area API - Error Example

Source: https://webservice.recruit.co.jp/hotpepper/small_area/v1?key=sample&middle_area=Y005

This snippet demonstrates a typical error response from the Hot Pepper Small Area API when an invalid API key is used, indicating that the key is restricted to reference page usage.

```APIDOC
## GET /hotpepper/small_area/v1

### Description
Retrieves small area information. This example shows an error response due to an invalid API key.

### Method
GET

### Endpoint
/hotpepper/small_area/v1

### Query Parameters
- **key** (string) - Required - Your API key. Note: The provided example key is restricted.

### Response
#### Error Response (400 or other error code)
- **code** (integer) - The error code.
- **message** (string) - A message describing the error.

#### Response Example
```xml
<results xmlns="http://webservice.recruit.co.jp/HotPepper/">
<api_version>1.30</api_version>
<error>
<code>2000</code>
<message>このAPIキーはリファレンスページからのみ利用可能です</message>
</error>
</results>
```
```

--------------------------------

### Search Large Area Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Example query to search the large area master data. Supports filtering by large area code or name. Requires an API key.

```http
http://webservice.recruit.co.jp/hotpepper/large_area/v1/?key=[APIキー]
```

--------------------------------

### Search Shops by Large Area Code

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This snippet demonstrates how to search for shops within a specific large area, using the example of 'Z011' for Tokyo.

```HTTP
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/?key=[APIキー]&large_area=Z011
```

--------------------------------

### Search Shops by Phone Number

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This snippet shows how to search for a shop by its exact phone number.

```HTTP
key=[APIキー]&tel=0312345678
```

--------------------------------

### Specify Response Format as JSON

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This parameter allows you to choose the response format, with options for XML (default) or JSON.

```HTTP
format=json
```

--------------------------------

### Budget Search API

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Retrieves a master list of dinner budget codes and their corresponding text representations.

```APIDOC
## GET /hotpepper/budget/v1/

### Description
Searches for dinner budget master data.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/budget/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - API key for authentication.
- **format** (string) - Optional - Response format (xml or json). Defaults to xml.

### Request Example
```
http://webservice.recruit.co.jp/hotpepper/budget/v1/?key=[APIキー]
```

### Response
#### Success Response (200)
- **api_version** (string) - API version.
- **results_available** (integer) - Total number of search results matching the query.
- **results_returned** (integer) - Number of search results included in this response.
- **results_start** (integer) - Starting position of the search results.
- **budget** (array) - Array of budget objects.
  - **code** (string) - Dinner budget code.
  - **name** (string) - Dinner budget text.

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<results xmlns="http://webservice.recruit.co.jp/HotPepper/">
  <api_version>1.20</api_version>
  <results_available>6</results_available>
  <results_returned>6</results_returned>
  <results_start>1</results_start>
  <budget>
    <code>B001</code>
    <name>～2000円</name>
  </budget>
</results>
```
```

--------------------------------

### Shop Search API

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Allows searching for shops based on keywords and other criteria. It returns detailed information about each shop found.

```APIDOC
## GET /hotpepper/shop/v1/

### Description
Searches for shops based on keywords and returns detailed information about each shop.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/shop/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - API key for authentication.
- **keyword** (string) - Optional - Search keywords (e.g., "オーガニック,東京").

### Request Example
```
http://webservice.recruit.co.jp/hotpepper/shop/v1/?key=[APIキー]&keyword=%E3%82%AA%E3%83%BC%E3%82%AC%E3%83%8B%E3%83%83%E3%82%AF%2C%E6%9D%B1%E4%BA%AC
```

### Response
#### Success Response (200)
- **api_version** (string) - API version.
- **results_available** (integer) - Total number of search results matching the query.
- **results_returned** (integer) - Number of search results included in this response.
- **results_start** (integer) - Starting position of the search results.
- **shop** (array) - Array of shop objects.
  - **id** (string) - Shop ID.
  - **name** (string) - Shop name.
  - **name_kana** (string) - Shop name in kana.
  - **address** (string) - Shop address.
  - **genre** (object)
    - **name** (string) - Genre name.
  - **urls** (object)
    - **pc** (string) - URL for PC.
  - **desc** (string) - Description flag (1 if target for Gourmet Search API, 0 otherwise).

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<results xmlns="http://webservice.recruit.co.jp/HotPepper/">
  <api_version>1.20</api_version>
  <results_available>47</results_available>
  <results_returned>1</results_returned>
  <results_start>1</results_start>
  <shop>
    <id>J000000000</id>
    <name>リクルートカフェ</name>
    <name_kana>りくるーとかふぇ</name_kana>
    <address>東京都中央区新橋</address>
    <genre>
      <name>カフェ・喫茶</name>
    </genre>
    <urls>
      <pc>http://www.hotpepper.jp/...</pc>
    </urls>
    <desc>0</desc>
  </shop>
</results>
```
```

--------------------------------

### Hot Pepper Gourmet Image Credit (Small)

Source: https://webservice.recruit.co.jp/doc/hotpepper/guideline.html

Use this HTML code to display the small image credit for Hot Pepper Gourmet Web Service. Ensure the link and image source are correctly implemented.

```html
<a href="http://webservice.recruit.co.jp/"><img src="http://webservice.recruit.co.jp/banner/hotpepper-s.gif" alt="ホットペッパーグルメ Webサービス" width="135" height="17" border="0" title="ホットペッパーグルメ Webサービス"></a>
```

--------------------------------

### Search Query Parameters

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This section details the parameters that can be used to construct a search query for the Hot Pepper API. These parameters allow for granular filtering of results based on a wide range of criteria.

```APIDOC
## Search Query Parameters

### Description
This section details the parameters that can be used to construct a search query for the Hot Pepper API. These parameters allow for granular filtering of results based on a wide range of criteria.

### Parameters

#### Query Parameters

- **key** (string) - Required - API key assigned for using the API.
- **id** (string) - Optional (*1) - Shop ID assigned to the shop. Up to 20 IDs can be specified.
- **name** (string) - Optional - Search by shop name (partial match).
- **name_kana** (string) - Optional - Search by shop name kana (partial match).
- **name_any** (string) - Optional - Search by shop name OR kana (partial match).
- **tel** (string) - Optional - Search by shop's phone number. Use half-width digits (no hyphens).
- **address** (string) - Optional - Search by shop's address (partial match).
- **special** (string) - Optional (*1) - Narrow down by AND condition of special codes. Special codes refer to the Special Master API. Multiple values can be specified.
- **special_or** (string) - Optional (*1) - Narrow down by OR condition of special codes. Special codes refer to the Special Master API. Multiple values can be specified.
- **special_category** (string) - Optional - Narrow down by AND condition of special category codes. Special category codes refer to the Special Category Master API. Multiple values can be specified.
- **special_category_or** (string) - Optional - Narrow down by OR condition of special category codes. Special category codes refer to the Special Category Master API. Multiple values can be specified.
- **large_service_area** (string) - Optional (*1) - Search by the code number assigned to the area. Refer to the Area Master API for assignable code numbers.
- **service_area** (string) - Optional - Up to 3 values can be specified.
- **large_area** (string) - Optional - Up to 3 values can be specified.
- **middle_area** (string) - Optional - Up to 5 values can be specified.
- **small_area** (string) - Optional - Up to 5 values can be specified.
- **keyword** (string) - Optional (*1) - Search by shop name kana, shop name, address, station name, shop genre catchphrase, or catchphrase free words (partial match). Character code is UTF8. Passing a string separated by half-width spaces results in an AND search. Multiple values can be specified.
- **lat** (string) - Optional (*1) - Latitude for searching shops within a certain range from a specific point.
- **lng** (string) - Optional - Longitude for searching shops within a certain range from a specific point.
- **range** (string) - Optional - Specifies the search range within a certain range from a specific point in 5 levels. For example, to search within 300m, specify range=1. (1: 300m, 2: 500m, 3: 1000m (default), 4: 2000m, 5: 3000m)
- **datum** (string) - Optional - Specifies the geodetic datum for latitude and longitude. world: World Geodetic System, tokyo: Old Japanese Geodetic System. Default is world.
- **ktai_coupon** (string) - Optional - Filter by the presence of mobile coupons. (1: No mobile coupons, 0: Mobile coupons available, Not specified: No filtering)
- **genre** (string) - Optional - Filter by shop genre (including sub-genres). Refer to the Genre Master API for assignable codes. Up to 2 values can be specified.
- **budget** (string) - Optional - Filter by dinner budget. Refer to the Dinner Budget Master API for assignable codes. Up to 2 values can be specified.
- **party_capacity** (string) - Optional - Filter by party capacity. Searches for shops with a larger capacity than the specified number.
- **wifi** (string) - Optional - Filter by shops where internet access via WiFi is available. (0: No filtering (default), 1: Filter)
- **wedding** (string) - Optional - Filter by shops where inquiries for weddings and second parties are possible. (0: No filtering (default), 1: Filter)
- **course** (string) - Optional - Filter by the condition "Course available". (0: No filtering (default), 1: Filter)
- **free_drink** (string) - Optional - Filter by the condition "All-you-can-drink". (0: No filtering (default), 1: Filter)
- **free_food** (string) - Optional - Filter by the condition "All-you-can-eat". (0: No filtering (default), 1: Filter)
- **private_room** (string) - Optional - Filter by the condition "Private rooms available". (0: No filtering (default), 1: Filter)
- **horigotatsu** (string) - Optional - Filter by the condition "Horigotatsu (Japanese-style sunken seating) available". (0: No filtering (default), 1: Filter)
- **tatami** (string) - Optional - Filter by the condition "Tatami seating available". (0: No filtering (default), 1: Filter)
- **cocktail** (string) - Optional - Filter by the condition "Cocktails available". (0: No filtering (default), 1: Filter)
- **shochu** (string) - Optional - Filter by the condition "Shochu available". (0: No filtering (default), 1: Filter)
- **sake** (string) - Optional - Filter by the condition "Sake available". (0: No filtering (default), 1: Filter)
- **wine** (string) - Optional - Filter by the condition "Wine available". (0: No filtering (default), 1: Filter)
- **card** (string) - Optional - Filter by the condition "Credit cards accepted". (0: No filtering (default), 1: Filter)
- **non_smoking** (string) - Optional - Filter by the condition "Non-smoking seats available". (0: No filtering (default), 1: Filter)
- **charter** (string) - Optional - Filter by the condition "Charter available". (0: No filtering (default), 1: Filter)
- **ktai** (string) - Optional - Filter by the condition "Mobile phone OK". (0: No filtering (default), 1: Filter)
- **parking** (string) - Optional - Filter by the condition "Parking available". (0: No filtering (default), 1: Filter)
- **barrier_free** (string) - Optional - Filter by the condition "Barrier-free access". (0: No filtering (default), 1: Filter)
- **sommelier** (string) - Optional - Filter by the condition "Sommelier available". (0: No filtering (default), 1: Filter)
- **night_view** (string) - Optional - Filter by the condition "Night view available". (0: No filtering (default), 1: Filter)
- **open_air** (string) - Optional - Filter by the condition "Open-air seating available". (0: No filtering (default), 1: Filter)
- **show** (string) - Optional - Filter by the condition "Live shows available". (0: No filtering (default), 1: Filter)
- **equipment** (string) - Optional - Filter by the condition "Entertainment equipment available". (0: No filtering (default), 1: Filter)
- **karaoke** (string) - Optional - Filter by the condition "Karaoke available". (0: No filtering (default), 1: Filter)
- **band** (string) - Optional - Filter by the condition "Live band performance allowed". (0: No filtering (default), 1: Filter)
- **tv** (string) - Optional - Filter by the condition "TV/Projector available". (0: No filtering (default), 1: Filter)
- **lunch** (string) - Optional - Filter by the condition "Lunch available". (0: No filtering (default), 1: Filter)
- **midnight** (string) - Optional - Filter by the condition "Open after 11 PM". (0: No filtering (default), 1: Filter)
- **midnight_meal** (string) - Optional - Filter by the condition "Meals available after 11 PM". (0: No filtering (default), 1: Filter)
- **english** (string) - Optional - Filter by the condition "English menu available". (0: No filtering (default), 1: Filter)
- **pet** (string) - Optional - Filter by the condition "Pets allowed". (0: No filtering (default), 1: Filter)
- **child** (string) - Optional - Filter by the condition "Child-friendly". (0: No filtering (default), 1: Filter)
- **credit_card** (string) - Optional - Filter by credit card type. Refer to the Credit Card Master API for assignable codes. (Added 2008/02/08) Multiple values can be specified.
- **type** (string) - Optional - Specifies the number of response items. lite: Outputs only main items. Refer to response fields for output items. credit_card, special: Adds credit cards and specials to the response. Multiple values can be specified by connecting with +. Example: type=credit_card+special to add both credit cards and specials to the response. (Default: Outputs all items except credit cards and specials)
- **order** (string) - Optional - Specifies the sort order of search results. Recommended order is updated periodically.
```

--------------------------------

### Search Query Parameters

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Parameters for performing searches, including sorting options, pagination, and response format.

```APIDOC
## Search Query Parameters

### Description
Parameters for performing searches, including sorting options, pagination, and response format.

### Query Parameters
- **start** (integer) - Optional - The starting position for the search results. Default: 1.
- **count** (integer) - Optional - The maximum number of results per page. Default: 10, Min: 1, Max: 100.
- **format** (string) - Optional - The response format. Options: 'xml' or 'json'. Default: 'xml'.

### Sorting
- **sort** (integer) - Optional - Specifies the sort order. Options:
  - 1: Alphabetical by shop name (kana)
  - 2: By genre code
  - 3: By small area code
  - 4: Recommended order (default)

Note: When using location-based search, options other than '4: Recommended order' will be forcibly sorted by distance.

### Parameter Specification
- At least one search parameter is required.
- Multiple parameters can be specified using `name=value1&name=value2&...` or `name=value1,value2,...`.
- If the number of specified parameters exceeds the limit, excess parameters will be ignored.
```

--------------------------------

### Shop Search API Endpoint

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

The base URL for performing shop searches using the Hot Pepper API.

```HTTP
http://webservice.recruit.co.jp/hotpepper/shop/v1/
```

--------------------------------

### Hot Pepper Gourmet Image Credit (Medium)

Source: https://webservice.recruit.co.jp/doc/hotpepper/guideline.html

This HTML code displays the medium-sized image credit for the Hot Pepper Gourmet Web Service. Verify the link and image source are accurate.

```html
<a href="http://webservice.recruit.co.jp/"><img src="http://webservice.recruit.co.jp/banner/hotpepper-m.gif" alt="ホットペッパーグルメ Webサービス" width="88" height="35" border="0" title="ホットペッパーグルメ Webサービス"></a>
```

--------------------------------

### Search Special Master by Category

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Use this endpoint to search the special master, filtering by a specific special category code.

```http
http://webservice.recruit.co.jp/hotpepper/special/v1/?key=[APIキー]&special_category=SPG6
```

--------------------------------

### Search Special Offers

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Retrieve a list of special offers based on provided criteria. Supports filtering by special code and special category code.

```APIDOC
## GET /special/v1/

### Description
Retrieves a list of special offers. You can filter by special code and special category code.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/special/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - API key for authentication.
- **special** (string) - Optional - Special code for exact match. Multiple codes can be specified.
- **special_category** (string) - Optional - Special category code for exact match. Multiple codes can be specified.
- **format** (string) - Optional - The response format. Can be 'xml' or 'json'. Defaults to 'xml'.

### Request Example
```json
{
  "example": "http://webservice.recruit.co.jp/hotpepper/special/v1/?key=[APIキー]&special=LJ0028"
}
```

### Response
#### Success Response (200)
- **api_version** (string) - API version.
- **results_available** (integer) - Total number of results available for the query.
- **results_returned** (integer) - Number of results returned in this response.
- **results_start** (integer) - The starting position of the results.

#### Response Example
```json
{
  "example": {
    "results": {
      "api_version": "1.20",
      "results_available": 100,
      "results_returned": 10,
      "results_start": 1
    }
  }
}
```
```

--------------------------------

### Hot Pepper Gourmet API Endpoint

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

The base URL for accessing the Hot Pepper Gourmet API.

```APIDOC
## Hot Pepper Gourmet API

### Description
This section details the request URL for the Hot Pepper Gourmet API.

### Endpoint
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/
```

--------------------------------

### Search Credit Card Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Retrieve a list of credit card types supported.

```APIDOC
## GET /credit_card/v1/

### Description
Retrieves a list of supported credit card types.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/credit_card/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - API key for authentication.
- **format** (string) - Optional - The response format. Can be 'xml' or 'json'. Defaults to 'xml'.

### Request Example
```json
{
  "example": "http://webservice.recruit.co.jp/hotpepper/credit_card/v1/?key=[APIキー]"
}
```

### Response
#### Success Response (200)
- **api_version** (string) - API version.
- **results_available** (integer) - Total number of results available for the query.
- **results_returned** (integer) - Number of results returned in this response.
- **results_start** (integer) - The starting position of the results.
- **credit_card** (array) - List of credit card objects.
  - **code** (string) - Credit card code.
  - **name** (string) - Credit card name.

#### Response Example
```json
{
  "example": {
    "results": {
      "api_version": "1.20",
      "results_available": 47,
      "results_returned": 47,
      "results_start": 1,
      "credit_card": [
        {
          "code": "c99",
          "name": "○○カード"
        }
      ]
    }
  }
}
```
```

--------------------------------

### Specify Number of Results per Page

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

This parameter controls the maximum number of search results to be returned per page, with a limit of 30.

```HTTP
count=10
```

--------------------------------

### Search Credit Card Master Data

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Use this endpoint to search for credit card master data. The API key is required.

```http
http://webservice.recruit.co.jp/hotpepper/credit_card/v1/?key=[APIキー]
```

--------------------------------

### Search Genre Master Data

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Use this endpoint to search for genre master data. You can filter by genre code or keyword for the genre name. The API key is required.

```http
http://webservice.recruit.co.jp/hotpepper/genre/v1/?key=[APIキー]
```

--------------------------------

### Hot Pepper Gourmet Text Credit

Source: https://webservice.recruit.co.jp/doc/hotpepper/guideline.html

Use this HTML code for the text-based credit of the Hot Pepper Gourmet Web Service. This is an alternative to using image credits.

```html
Powered by <a href="http://webservice.recruit.co.jp/">ホットペッパーグルメ Webサービス</a>
```

--------------------------------

### Search Special Category Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Use this endpoint to search the special category master. This is the base URL for retrieving special category information.

```http
http://webservice.recruit.co.jp/hotpepper/special_category/v1/?key=[APIキー]
```

--------------------------------

### Search Small Area Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Retrieve a list of small areas based on provided criteria. Supports filtering by small area code, middle area code, and keyword.

```APIDOC
## GET /small_area/v1/

### Description
Retrieves a list of small areas. You can filter by small area code, middle area code, and search by small area name.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/small_area/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - API key for authentication.
- **small_area** (string) - Optional - Small area code for exact match. Up to 5 codes can be specified.
- **middle_area** (string) - Optional - Middle area code for exact match. Up to 5 codes can be specified.
- **keyword** (string) - Optional - Small area name for partial match. Must be URL-encoded.
- **start** (integer) - Optional - The starting position for search results. Defaults to 1.
- **count** (integer) - Optional - The maximum number of results to return per page. Minimum 1.
- **format** (string) - Optional - The response format. Can be 'xml' or 'json'. Defaults to 'xml'.

### Request Example
```json
{
  "example": "http://webservice.recruit.co.jp/hotpepper/small_area/v1/?key=[APIキー]&middle_area=Y005"
}
```

### Response
#### Success Response (200)
- **api_version** (string) - API version.
- **results_available** (integer) - Total number of results available for the query.
- **results_returned** (integer) - Number of results returned in this response.
- **results_start** (integer) - The starting position of the results.
- **small_area** (array) - List of small area objects.
  - **code** (string) - Small area code.
  - **name** (string) - Small area name.
  - **middle_area** (object) - Information about the middle area.
    - **code** (string) - Middle area code.
    - **name** (string) - Middle area name.
  - **large_area** (object) - Information about the large area.
    - **code** (string) - Large area code.
    - **name** (string) - Large area name.
  - **service_area** (object) - Information about the service area.
    - **code** (string) - Service area code.
    - **name** (string) - Service area name.
  - **large_service_area** (object) - Information about the large service area.
    - **code** (string) - Large service area code.
    - **name** (string) - Large service area name.

#### Response Example
```json
{
  "example": {
    "results": {
      "api_version": "1.20",
      "results_available": 530,
      "results_returned": 530,
      "results_start": 1,
      "small_area": [
        {
          "code": "X150",
          "name": "東口・歌舞伎町方面",
          "middle_area": {"code": "Y055", "name": "新宿"},
          "large_area": {"code": "Z011", "name": "東京"},
          "service_area": {"code": "SA11", "name": "東京"},
          "large_service_area": {"code": "SS10", "name": "関東"}
        }
      ]
    }
  }
}
```
```

--------------------------------

### Search Genre Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Retrieve a list of genres based on provided criteria. Supports filtering by genre code and keyword.

```APIDOC
## GET /genre/v1/

### Description
Retrieves a list of genres. You can filter by genre code and search by genre name.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/genre/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - API key for authentication.
- **code** (string) - Optional - Genre code for exact match. Up to 2 codes can be specified.
- **keyword** (string) - Optional - Genre name for partial match. Must be URL-encoded.
- **format** (string) - Optional - The response format. Can be 'xml' or 'json'. Defaults to 'xml'.

### Request Example
```json
{
  "example": "http://webservice.recruit.co.jp/hotpepper/genre/v1/?key=[APIキー]"
}
```

### Response
#### Success Response (200)
- **api_version** (string) - API version.
- **results_available** (integer) - Total number of results available for the query.
- **results_returned** (integer) - Number of results returned in this response.
- **results_start** (integer) - The starting position of the results.
- **genre** (array) - List of genre objects.
  - **code** (string) - Genre code.
  - **name** (string) - Genre name.

#### Response Example
```json
{
  "example": {
    "results": {
      "api_version": "1.20",
      "results_available": 15,
      "results_returned": 15,
      "results_start": 1,
      "genre": [
        {
          "code": "G002",
          "name": "ダイニングバー"
        }
      ]
    }
  }
}
```
```

--------------------------------

### Search Special Category Master

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Allows searching for special category master data.

```APIDOC
## GET /hotpepper/special_category/v1/

### Description
Searches for special category master data.

### Method
GET

### Endpoint
http://webservice.recruit.co.jp/hotpepper/special_category/v1/

### Parameters
#### Query Parameters
- **key** (string) - Required - API key for authentication.
- **special_category** (string) - Optional - Special category code to filter results by (exact match). Multiple values can be specified using '&' or ','.
- **format** (string) - Optional - Specifies the response format. Defaults to 'xml'. Possible values: 'xml', 'json'.

### Request Example
```
http://webservice.recruit.co.jp/hotpepper/special_category/v1/?key=[APIキー]
```

### Response
#### Success Response (200)
- **results** (object) - Contains results information.
  - **api_version** (string) - API version.
  - **results_available** (integer) - Total number of search results matching the query.
  - **results_returned** (integer) - Number of search results included in this response.
  - **results_start** (integer) - Starting position of the search results.
  - **special_category** (array) - Contains special category data.
    - **code** (string) - Special category code.
    - **name** (string) - Special category name.

#### Response Example
```json
{
  "results": {
    "api_version": "1.20",
    "results_available": 5,
    "results_returned": 5,
    "results_start": 1,
    "special_category": [
      {
        "code": "SPX0",
        "name": "特典・サービスで選ぶ"
      }
    ]
  }
}
```

### Error Handling
- The API always returns an HTTP status code of "200 OK", even for errors. Implementations must check the response content for error details.
- **Error Codes**:
  - 1000: Server error.
  - 2000: Authentication error (API key or IP address).
  - 3000: Invalid parameter error.
```

--------------------------------

### Search Small Area Master Data

Source: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Use this endpoint to search for small area master data. You can filter by small area code, middle area code, or keyword for the small area name. The API key is required.

```http
http://webservice.recruit.co.jp/hotpepper/small_area/v1/?key=[APIキー]&middle_area=Y005
```
Tokens:
Raw