> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anysite.io/llms.txt
> Use this file to discover all available pages before exploring further.

# /hotpepper/restaurants/search

> Search Hot Pepper Gourmet (ホットペッパーグルメ) restaurants within a prefecture by keyword and/or genre with optional filters: budget range (dinner or lunch), usage scene, amenity features (こだわり), smoking policy, online/instant reservation, points, takeout, smart payment and coupons. Returns restaurant cards with name, image, genre, area, catch copy, keywords, access, dinner/lunch budgets and coupon titles.

**Price:** 10 credits per 20 results

**💡 AI Hint:** Search Hot Pepper Gourmet (ホットペッパーグルメ) restaurants. Always provide area (Japanese prefecture) and at least one of keyword or genre. Optional: budget_min/budget_max (JPY per person, budget_for_lunch to target lunch), scene, features (こだわり list), smoking, net_reserve, instant_reserve, point_earn/point_use/point_plus, takeout, smart_pay, covid_info, has_coupon. Use keyword to narrow by sub-area, station or dish. Each result has id ('J003433499'), url, name, image, genre, area, catch_copy, keywords, access, budget_dinner/budget_lunch and coupons.



## OpenAPI

````yaml /openapi-filtered.json post /api/hotpepper/restaurants/search
openapi: 3.1.0
info:
  title: Any Site API
  description: >+
    Any Site API provides programmatic access to data from LinkedIn, Instagram,
    Twitter, and other platforms.


    ## Authentication


    All API endpoints require an `access-token` header with a valid API token.
    Tokens can be created in the [dashboard](https://app.anysite.io/).


    ## Pricing


    Each endpoint has a credit cost listed in its description. Credits are
    deducted from your token balance per request.

  version: 0.0.1
servers: []
security:
  - AccessToken: []
paths:
  /api/hotpepper/restaurants/search:
    post:
      tags:
        - /hotpepper
      summary: /hotpepper/restaurants/search
      description: >-
        Search Hot Pepper Gourmet (ホットペッパーグルメ) restaurants within a prefecture
        by keyword and/or genre with optional filters: budget range (dinner or
        lunch), usage scene, amenity features (こだわり), smoking policy,
        online/instant reservation, points, takeout, smart payment and coupons.
        Returns restaurant cards with name, image, genre, area, catch copy,
        keywords, access, dinner/lunch budgets and coupon titles.


        **Price:** 10 credits per 20 results


        **💡 AI Hint:** Search Hot Pepper Gourmet (ホットペッパーグルメ) restaurants.
        Always provide area (Japanese prefecture) and at least one of keyword or
        genre. Optional: budget_min/budget_max (JPY per person, budget_for_lunch
        to target lunch), scene, features (こだわり list), smoking, net_reserve,
        instant_reserve, point_earn/point_use/point_plus, takeout, smart_pay,
        covid_info, has_coupon. Use keyword to narrow by sub-area, station or
        dish. Each result has id ('J003433499'), url, name, image, genre, area,
        catch_copy, keywords, access, budget_dinner/budget_lunch and coupons.
      operationId: __api_hotpepper_restaurants_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HotpepperSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HotpepperSearchCard'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HotpepperSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          description: Max scrapping execution timeout (in seconds)
          default: 300
        area:
          $ref: '#/components/schemas/HotpepperPrefecture'
          description: Prefecture to scope the search
        keyword:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Free-text keyword — narrows by sub-area, station, shop name or dish
            (e.g. '渋谷', '新宿駅', '刺身')
          examples:
            - 個室
            - 焼肉
            - 渋谷
            - 刺身
        genre:
          anyOf:
            - $ref: '#/components/schemas/HotpepperGenre'
            - type: 'null'
          description: Restaurant genre filter
        budget_min:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          description: Minimum per-person budget (JPY)
        budget_max:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          description: Maximum per-person budget (JPY)
        budget_for_lunch:
          type: boolean
          description: Apply the budget filter to lunch instead of dinner
          default: false
        scene:
          anyOf:
            - $ref: '#/components/schemas/HotpepperScene'
            - type: 'null'
          description: Usage scene filter
        features:
          items:
            $ref: '#/components/schemas/HotpepperFeature'
          type: array
          description: Amenity/feature filters (こだわり)
          default: []
        smoking:
          anyOf:
            - $ref: '#/components/schemas/HotpepperSmoking'
            - type: 'null'
          description: Smoking policy filter
        net_reserve:
          type: boolean
          description: Only restaurants with online reservation
          default: false
        instant_reserve:
          type: boolean
          description: Only restaurants with instant online reservation
          default: false
        point_earn:
          type: boolean
          description: Only restaurants where points can be earned
          default: false
        point_use:
          type: boolean
          description: Only restaurants where points can be spent
          default: false
        point_plus:
          type: boolean
          description: Only restaurants in the bonus-point (point plus) program
          default: false
        takeout:
          type: boolean
          description: Only restaurants offering takeout
          default: false
        smart_pay:
          type: boolean
          description: Only restaurants accepting smart (online) payment
          default: false
        covid_info:
          type: boolean
          description: Only restaurants publishing infection-control information
          default: false
        has_coupon:
          type: boolean
          description: Only restaurants with coupons
          default: false
        count:
          type: integer
          minimum: 1
          description: Max number of results to return
      type: object
      required:
        - area
        - count
    HotpepperSearchCard:
      properties:
        '@type':
          type: string
          default: HotpepperSearchCard
        id:
          type: string
        url:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        image:
          anyOf:
            - type: string
            - type: 'null'
        genre:
          anyOf:
            - type: string
            - type: 'null'
        area:
          anyOf:
            - type: string
            - type: 'null'
        catch_copy:
          anyOf:
            - type: string
            - type: 'null'
        keywords:
          anyOf:
            - type: string
            - type: 'null'
        access:
          anyOf:
            - type: string
            - type: 'null'
        budget_dinner:
          anyOf:
            - type: string
            - type: 'null'
        budget_lunch:
          anyOf:
            - type: string
            - type: 'null'
        coupons:
          items:
            type: string
          type: array
          default: []
      type: object
      required:
        - id
        - url
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    HotpepperPrefecture:
      type: string
      enum:
        - hokkaido
        - aomori
        - iwate
        - miyagi
        - akita
        - yamagata
        - fukushima
        - tokyo
        - kanagawa
        - saitama
        - chiba
        - ibaraki
        - tochigi
        - gunma
        - niigata
        - toyama
        - ishikawa
        - fukui
        - yamanashi
        - nagano
        - gifu
        - shizuoka
        - aichi
        - mie
        - shiga
        - kyoto
        - osaka
        - hyogo
        - nara
        - wakayama
        - tottori
        - shimane
        - okayama
        - hiroshima
        - yamaguchi
        - tokushima
        - kagawa
        - ehime
        - kochi
        - fukuoka
        - saga
        - nagasaki
        - kumamoto
        - oita
        - miyazaki
        - kagoshima
        - okinawa
    HotpepperGenre:
      type: string
      enum:
        - izakaya
        - dining_bar
        - creative_cuisine
        - japanese
        - western
        - italian_french
        - chinese
        - yakiniku
        - asian_ethnic
        - world_cuisine
        - karaoke_party
        - bar
        - ramen
        - cafe_sweets
        - other_gourmet
        - okonomiyaki
        - korean
    HotpepperScene:
      type: string
      enum:
        - date
        - friends
        - family
        - business_dining
        - solo
        - large_banquet
        - company_banquet
        - anniversary
        - group_date
    HotpepperFeature:
      type: string
      enum:
        - course
        - all_you_can_drink
        - all_you_can_eat
        - private_room
        - horigotatsu
        - tatami
        - cocktails
        - shochu
        - sake
        - wine
        - card_ok
        - charter
        - parking
        - barrier_free
        - night_view
        - live_show
        - karaoke
        - band
        - tv_projector
        - lunch
        - open_after_23
        - food_after_23
        - english_menu
        - pets_ok
        - kids_ok
        - wifi
        - counter
        - sofa
        - terrace
        - celebration
        - e_money
        - sunday_open
    HotpepperSmoking:
      type: string
      enum:
        - non_smoking
        - separated
        - smoking_ok
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: access-token
      description: API token from the dashboard

````