About this endpoint
What it does
Crawls a website starting from the submitted url and extracts contact and social signals from the pages it scans. The request lets you limit how many pages are scanned and choose whether entity extraction is included.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The website URL to crawl. |
| max_pages | Integer | No | Maximum number of pages to scan. Default: 5. Minimum: 1. Maximum: 25. |
| include_entities | Boolean | No | Whether to extract named entities. Default: true. |
Response
Returns a JSON object with url and final_url string fields, emails, phones, addresses, business_names, named_entities, and social_profiles array fields, and a pages_scanned integer field. These fields contain the crawled source URL, the final resolved URL, extracted contact data, extracted entity data, social profile data, and the number of pages scanned.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The submitted source URL. |
| emails | String Array | No | Email addresses found during crawling. |
| phones | String Array | No | Phone numbers found during crawling. |
| addresses | String Array | No | Addresses found during crawling. |
| final_url | String | No | The final URL reached after following redirects, if applicable. |
| pages_scanned | Integer | No | Number of pages scanned. |
| business_names | String Array | No | Business names found during crawling. |
| named_entities | Object Array | No | Named entities extracted from the crawled content. Each item contains text and label. |
| social_profiles | Object Array | No | Social profiles found during crawling. Each item contains url and network. |