About this endpoint
What it does
Extracts contact details from a webpage identified by URL and returns the discovered contact-related fields in a JSON object.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | URL of the webpage to extract, audit, or validate content from. Must be an http or https URI. |
Response
Returns a JSON object with emails, phones, addresses, confidence, source_url, and social_links fields. The collection fields are arrays of strings, confidence is an object with numeric confidence scores, source_url is a URI string, and social_links is an object whose values are URI strings.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| emails | String Array | No | Extracted email addresses. |
| phones | String Array | No | Extracted phone numbers. |
| addresses | String Array | No | Extracted addresses. |
| confidence | Object | No | Confidence scores for extracted fields. Contains emails, phones, and social numeric values. |
| confidence.emails | Number | No | Confidence score for emails. |
| confidence.phones | Number | No | Confidence score for phones. |
| confidence.social | Number | No | Confidence score for social links. |
| source_url | String | No | Source webpage URL, formatted as a URI. |
| social_links | Object | No | Social links keyed by property name; each value is a URI string. |