Quickstart
Get a key, run a scraper and fetch its records, in three requests.
Three requests take you from nothing to job records: create a key, start a run, read what it found.
1. Get an API key#
Sign up in the EnrichedNow console, open API keys and create a key. The secret is shown once, when the key
is created — copy it then. It looks like en_live_ followed by 32 or more characters.
Keep it out of your code. The examples on this site read it from an environment variable:
export ENRICHEDNOW_API_KEY="en_live_..."More in Authentication.
2. Run a scraper#
Every scraper is started the same way: POST /v1/scrapers/{id}/runs with the scraper's input under input.
This example reads the job openings from one applicant-tracking-system board with ats.board.
Adding wait=60 asks the API to hold the request open for up to 60 seconds, so a run that finishes in that
time comes back complete.
curl -X POST "https://api.enrichednow.com/v1/scrapers/ats.board/runs?wait=60" \
-H "Authorization: Bearer $ENRICHEDNOW_API_KEY" \
-H "Content-Type: application/json" \
-d '{"input": {"board_url": "https://boards.greenhouse.io/acme"}}'import os
import requests
API = "https://api.enrichednow.com"
HEADERS = {"Authorization": f"Bearer {os.environ['ENRICHEDNOW_API_KEY']}"}
response = requests.post(
f"{API}/v1/scrapers/ats.board/runs",
params={"wait": 60},
headers=HEADERS,
json={"input": {"board_url": "https://boards.greenhouse.io/acme"}},
timeout=90,
)
response.raise_for_status()
run = response.json()
print(run["id"], run["status"], run["record_count"])const API = "https://api.enrichednow.com";
const headers = {
Authorization: `Bearer ${process.env.ENRICHEDNOW_API_KEY}`,
"Content-Type": "application/json",
};
const response = await fetch(`${API}/v1/scrapers/ats.board/runs?wait=60`, {
method: "POST",
headers,
body: JSON.stringify({ input: { board_url: "https://boards.greenhouse.io/acme" } }),
});
if (!response.ok) throw new Error(JSON.stringify(await response.json()));
const run = await response.json();
console.log(run.id, run.status, run.record_count);The answer is a run. This one is what the API returned for that request:
{
"id": "run_6cce2b12aaf37a10b5e1b885",
"scraper_id": "ats.board",
"scraper_version": 1,
"status": "ok",
"reason": null,
"input": {
"board_url": "https://boards.greenhouse.io/acme"
},
"record_count": 19,
"units": 1,
"diagnostics": {
"requests": 1,
"bytes": 232779,
"wall_ms": 565,
"facts": {
"careers_url": "https://boards.greenhouse.io/acme",
"discovery": "supplied",
"ats": "greenhouse",
"pages_read": 1,
"renders_refused": 0
}
},
"created_at": "2026-11-16T20:27:29.009834Z",
"started_at": "2026-11-16T20:27:29.013803Z",
"finished_at": "2026-11-16T20:27:29.582787Z"
}Two things can come back:
200— the run ended within yourwait. Itsstatusis final:ok,partial,failed,unsupportedorcancelled.202— the run is stillqueuedorrunning. Ask for it again withGET /v1/runs/{id}until it ends; Running a scraper has a polling loop.
3. Fetch the records#
The run tells you how many records it found; the records themselves are a separate, paged request.
A page holds 100 records unless you ask for another limit, up to 1000.
curl "https://api.enrichednow.com/v1/runs/run_6cce2b12aaf37a10b5e1b885/records?limit=100" \
-H "Authorization: Bearer $ENRICHEDNOW_API_KEY"records, cursor = [], None
while True:
params = {"limit": 1000, **({"cursor": cursor} if cursor else {})}
page = requests.get(f"{API}/v1/runs/{run['id']}/records", params=params, headers=HEADERS, timeout=30)
page.raise_for_status()
body = page.json()
records += body["records"]
cursor = body["next_cursor"]
if cursor is None:
break
print(len(records), "records;", records[0]["title"] if records else "none")const records = [];
let cursor = null;
do {
const url = new URL(`${API}/v1/runs/${run.id}/records`);
url.searchParams.set("limit", "1000");
if (cursor) url.searchParams.set("cursor", cursor);
const page = await fetch(url, { headers });
if (!page.ok) throw new Error(JSON.stringify(await page.json()));
const body = await page.json();
records.push(...body.records);
cursor = body.next_cursor;
} while (cursor);
console.log(records.length, "records;", records[0]?.title ?? "none");{
"records": [
{
"title": "Senior Software Engineer",
"company_name": "Acme",
"company_domain": null,
"location": { "raw": "Austin, TX", "city": "Austin", "region": "TX", "country": "United States", "remote": false },
"employment_type": "Full-time",
"posted_at": "2026-11-03",
"valid_through": null,
"salary": null,
"description": "We are looking for an engineer to work on our ingestion pipeline…",
"apply_url": "https://boards.greenhouse.io/acme/jobs/4567890",
"page_url": "https://boards.greenhouse.io/acme/jobs/4567890",
"ats": "greenhouse",
"external_id": "4567890",
"fetched_at": "2026-11-17T09:30:01Z"
}
],
"next_cursor": null
}A value we do not know is null — never an empty string and never 0.
Records are kept for 7 days after the run ended. Fetch them and store what you need.
Where next#
- Running a scraper —
wait, polling, paging and cancelling in full. - Results and statuses — every status and reason code.
- Scrapers — what each scraper takes and returns.
- Usage and units — what a run costs.