# Free APIs

As we want to ensure your project will be successful with little development on your side, we developed the following free APIs that will better help you interact with our services.

{% hint style="info" %}
GET is the only supported HTTP method for the free APIs.
{% endhint %}

### #1: Locations API

The Locations API returns SERP API supported locations. It can be accessed via `https://locations.webscrapingapi.com/` and its allowed parameters are:

<table><thead><tr><th width="139">Parameter</th><th width="104" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>q</code></td><td align="center"><code>string</code></td><td>Searches locations that contain the supplied string</td></tr><tr><td><code>limit</code><br> <mark style="color:red;background-color:red;">Required</mark> </td><td align="center"><code>int</code></td><td>Limit the number of results returned by the API</td></tr></tbody></table>

A basic URL example for the locations API is:

{% code overflow="wrap" %}

```
https://locations.webscrapingapi.com?q=<LOCATION>&limit=<NUMBER>
```

{% endcode %}

## Location API Request Example

<mark style="color:blue;">`GET`</mark> `https://locations.webscrapingapi.com?q=Austin&limit=5`

`GET` the first 5 available locations which include `Austin` in their name.

#### Query Parameters

| Name                                    | Type    | Description |
| --------------------------------------- | ------- | ----------- |
| q                                       | String  | `Austin`    |
| limit<mark style="color:red;">\*</mark> | Integer | `5`         |

{% tabs %}
{% tab title="200: OK Successfully retrieved supported locations" %}

```javascript
[
    {
        "Criteria ID": "1001982",
        "Name": "Austin",
        "Canonical Name": "Austin",
        "Parent ID": "Manitoba",
        "Country Code": "Canada",
        "Target Type": "20115",
        "Status": "CA"
    },
    {
        "Criteria ID": "1005691",
        "Name": "Kaustinen",
        "Canonical Name": "Kaustinen",
        "Parent ID": "Central Ostrobothnia",
        "Country Code": "Finland",
        "Target Type": "9075500",
        "Status": "FI"
    },
    {
        "Criteria ID": "1014438",
        "Name": "Austin",
        "Canonical Name": "Austin",
        "Parent ID": "Colorado",
        "Country Code": "United States",
        "Target Type": "21138",
        "Status": "US"
    },
    {
        "Criteria ID": "1016989",
        "Name": "Austin",
        "Canonical Name": "Austin",
        "Parent ID": "Indiana",
        "Country Code": "United States",
        "Target Type": "21148",
        "Status": "US"
    },
    {
        "Criteria ID": "1019697",
        "Name": "Austin",
        "Canonical Name": "Austin",
        "Parent ID": "Minnesota",
        "Country Code": "United States",
        "Target Type": "21156",
        "Status": "US"
    }
]
```

{% endtab %}
{% endtabs %}

### #2: Amazon Helpers API

The Amazon Helpers API allows you to fetch Amazon Search API supported Categories, Languages and Countries for Amazon Search. It can be accessed via `https://amazon-helpers.webscrapingapi.com/` and the available endpoints are:

* `https://amazon-helpers.webscrapingapi.com/`<mark style="color:green;">**`categories`**</mark>

The allowed parameters for the `categories` endpoint are:

<table><thead><tr><th width="139">Parameter</th><th width="104" align="center">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>q</code></td><td align="center"><code>string</code></td><td>Searches categories that contain the supplied string.</td></tr><tr><td><code>limit</code></td><td align="center"><code>int</code></td><td>Limit the number of results returned by the API</td></tr></tbody></table>

A basic URL example for the `categories` endpoint is:

{% code overflow="wrap" %}

```
https://amazon-helpers.webscrapingapi.com/categories?q=<NAME>&limit=<NUMBER>
```

{% endcode %}

## Amazon Categories API Request Example

<mark style="color:blue;">`GET`</mark> `https://amazon-helpers.webscrapingapi.com/categories?q=Baby&limit=10`

`GET` the first 10 available Amazon Categories which include `Baby` in their name.

#### Query Parameters

| Name  | Type    | Description |
| ----- | ------- | ----------- |
| q     | String  | `Baby`      |
| limit | Integer | `10`        |

{% tabs %}
{% tab title="200: OK Successfully retrieved supported locations" %}

```javascript
[    
    {        
        "category_id": "3045",       
        "parent_alias": "books",       
        "category_title": "Children's Family Life Books",        
        "page_title": "Amazon.com: Family Life: Books: Sleep, Parents, New Baby, Siblings, Values, Multigenerational & More",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=3045"    
    },    
    {        
        "category_id": "3056",        
        "parent_alias": "books",        
        "category_title": "Children's New Baby Books",        
        "page_title": "Amazon.com: New Baby: Books",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=3056"    
    },    
    {        
        "category_id": "4873",        
        "parent_alias": "books",        
        "category_title": "Ancient Civilizations",        
        "page_title": "Amazon.com: Ancient Civilizations: Books: Rome, Greece, Egypt, Mesopotamia, Assyria, Babylonia & Sumer & More",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=4873"    
    },    
    {        
        "category_id": "4874",        
        "parent_alias": "books",        
        "category_title": "Assyria, Babylonia & Sumer History",        
        "page_title": "Amazon.com: Assyria, Babylonia & Sumer: Books",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=4874"    
    },    
    {        
        "category_id": "11403",        
        "parent_alias": "books",        
        "category_title": "Baby & Toddler Parenting",        
        "page_title": "Amazon.com: Early Childhood: Books",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=11403"    
    },    
    {        
        "category_id": "1044510",        
        "parent_alias": "fashion",        
        "category_title": "Baby Boy's Clothing",        
        "page_title": "Amazon.com : Baby Boy's Clothing",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=1044510"    
    },    
    {        
        "category_id": "1044520",        
        "parent_alias": "fashion",        
        "category_title": "Baby Boys' One-Piece Rompers",        
        "page_title": "Amazon.com : Baby Boys' One-Piece Rompers",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=1044520"    
    },    
    {        
        "category_id": "1044532",        
        "parent_alias": "fashion",        
        "category_title": "Baby Girls' Tops",        
        "page_title": "Amazon.com : Baby Girls' Tops",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=1044532"    
    },    
    {        
        "category_id": "1044536",        
        "parent_alias": "fashion",        
        "category_title": "Baby Girls' Bloomers, Diaper Covers & Underwear",        
        "page_title": "Amazon.com : Baby Girls' Bloomers, Diaper Covers & Underwear",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=1044536"    
    },    
    {        
        "category_id": "1044542",        
        "parent_alias": "fashion",        
        "category_title": "Baby Girls' Dresses",        
        "page_title": "Amazon.com : Baby Girls' Dresses",        
        "link": "https://www.amazon.com/b?ie=UTF8&node=1044542"    
    }
]
```

{% endtab %}
{% endtabs %}

* `https://amazon-helpers.webscrapingapi.com/`<mark style="color:green;">**countries**</mark>

A basic URL example for the `countries` endpoint is:

{% code overflow="wrap" %}

```
https://amazon-helpers.webscrapingapi.com/countries
```

{% endcode %}

* `https://amazon-helpers.webscrapingapi.com/`<mark style="color:green;">**`languages`**</mark>

A basic URL example for the `languages` endpoint is:

{% code overflow="wrap" %}

```
https://amazon-helpers.webscrapingapi.com/languages
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.webscrapingapi.com/readme/free-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
