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

# Extract TheFork Reviews

> Extract customer reviews from pages listed on TheFork.

To extract customer reviews from TheFork, follow these steps to input the necessary data and configure the parameters for optimal results.

<Steps>
  <Step title="Access TheFork">
    Go to <a href="https://www.thefork.com/">The Fork</a> and navigate to a
    restaurant's profile.
  </Step>

  <Step title="Copy URL">Copy the URL from your browser's address bar.</Step>
  <Step title="Input URL">Paste the URL into the provided input field.</Step>
</Steps>

### Inputs

<ParamField path="thefork_reviews_url" type="string" required={true} primary={true}>
  Input should contain a valid restaurant ID such as "r667039" and point towards
  a review page.
</ParamField>

### Parameters

<ParamField path="max_results" type="number" default={100} initialValue={100}>
  Maximum number of results. Limits the number of reviews collected by page.
  Minimum is 1 and maximum is 5000.
</ParamField>

<ParamField path="lang" type="string" default="en">
  Language setting replicates The Fork's language system. Available options:
  English, French, Italian, German, Spanish.
</ParamField>

<ParamField path="sort" type="string" default="newest">
  Determines the order of the reviews. Options include: Highest Rating First,
  Lowest Rating First, Newest Rating First, Oldest Rating First.
</ParamField>

### Output Fields

The following fields are extracted from the reviews:

<ResponseField>
  <Expandable title="properties">
    <ResponseField name="answer" type="string">
      The response to the review, if any.
    </ResponseField>

    <ResponseField name="answer_status" type="string">
      Status of the response to the review.
    </ResponseField>

    <ResponseField name="author_name" type="string">
      Name of the review author.
    </ResponseField>

    <ResponseField name="author_number_of_reviews" type="integer">
      Number of reviews written by the author.
    </ResponseField>

    <ResponseField name="content" type="string">
      Content of the review.
    </ResponseField>

    <ResponseField name="cooking_grade" type="integer">
      Grade given for cooking.
    </ResponseField>

    <ResponseField name="experience_date" type="string">
      Date of the dining experience.
    </ResponseField>

    <ResponseField name="grade" type="integer">
      Overall grade of the review.
    </ResponseField>

    <ResponseField name="property_id" type="string">
      ID of the property being reviewed.
    </ResponseField>

    <ResponseField name="property_url" type="string">
      URL of the property being reviewed.
    </ResponseField>

    <ResponseField name="review_id" type="string">
      Unique identifier for the review.
    </ResponseField>

    <ResponseField name="service_grade" type="integer">
      Grade given for service.
    </ResponseField>

    <ResponseField name="setting_grade" type="integer">
      Grade given for the setting.
    </ResponseField>
  </Expandable>
</ResponseField>

Below is the JSON schema for the output fields:

<Accordion title="Show JSON Output Schema">
  ```json
  {
    "answer": "string",
    "answer_status": "string",
    "author_name": "string",
    "author_number_of_reviews": "integer",
    "content": "string",
    "cooking_grade": "integer",
    "experience_date": "string",
    "grade": "integer",
    "property_id": "string",
    "property_url": "string",
    "review_id": "string",
    "service_grade": "integer",
    "setting_grade": "integer"
  }
  ```
</Accordion>