Create a Parser

Create a new parser based on example URLs

POST https://aiparser.scraperapi.com/parsers

Request body

{
  "name": "Quotes Scraper",
  "api_key": "API_KEY",
  "urls": [
    "http://quotes.toscrape.com/page/1/",
    "http://quotes.toscrape.com/page/2/",
    "http://quotes.toscrape.com/page/3/"
  ],
  //optional
  "scraper_params": {
    "country_code": "us"
  },
  //optional
  "fields": [
    {
      "name": "quotes.text",
      "description": "The full quote text",
      "type": "string"
    },
    {
      "name": "quotes.author",
      "description": "Product price in USD",
      "type": "number"
    }
  ]
}

---

Field	Required	Description
name	Yes	Name identifier for the generated parser.
api_key	Yes	Your ScraperAPI API Key.
urls	Yes	1-3 example URLs of the same type.
scraper_params	No	ScraperAPI parameters to be used when fetching the example pages - see supported parameters.
fields	No	Predefined fields to guide generation. Each supports name, description, type (string, number, array), and an optional CSS or XPath selector. Use dot notation for nested fields (e.g. "products.name")

Response

{
    "id": "parser_id",
    "version": 0
}

The parser starts generating asynchronously. Poll GET /parsers/{id} to check status.

Tips for Example URLs

• Use the same URL types - three product pages, not a product page + a category page.

• Pick Variations - items with and without sales prices, in-stock and out-of-stock, etc. to teach the parser edge cases.

• Make sure they are accessible - if the URLs require JavaScript rendering, set render=true in scraper_params.

Supported ScraperAPI parameters

These can be set in scraper_params when creating the parser, and used as query params when calling /parse

Parameter	Type	Description
render	Boolean	Enables JavaScript rendering
country_code	String	Two-letter country code (e.g. US)
premium	Boolean	Use residential proxies
session_number	Integer	Maintain the same IP across requests
keep_headers	Boolean	Preserve custom headers you send
device_type	String	desktop or mobile
ultra_premium	Boolean	Use advanced unblocking mechanisms
follow_redirect	Boolean	Follow HTTP redirects (default true)
retry_404	Boolean	Retry 404 responses