POST Request: Real-time Employee API

Data type:

Query type

URL:

Base Employee

Real-time data scraping

https://api.coresignal.com/rtapi/v2/employee/scrape

---

Overview

Use this endpoint to request the scraping of a specific user profile. Simply provide the profile URL and specify the max_age.

Explore the fields in the endpoint payload and their descriptions to gain insights into Real-time Employee API usage.

Request parameters

url

The url field requires an employee profile URL. Learn more about valid URLs on URLs Validation page.

max_age

This is the maximum number of hours a URL can be cached for and still remain valid. If you choose a greater max_age value than the scraped profile is stored in cache, then the data from cache is returned. If lower – scraping is done right away.

Request body

{
  "url": "string",
  "max_age": number
}

cURL request

The request may last for 30 seconds. If it fails to scrape within 30 seconds, then a timeout is returned.

Request

curl -X 'POST' \
  'https://api.coresignal.com/rtapi/v2/employee/scrape' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://www.professional-network.com/john-doe",
  "max_age": 336
}'