Skip to the content
EnrichedNowDocs

    Type to search every page.

    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:

    Shell
    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.

    Shell
    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"}}'

    The answer is a run. This one is what the API returned for that request:

    200 · JSON
    {
      "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 your wait. Its status is final: ok, partial, failed, unsupported or cancelled.
    • 202 — the run is still queued or running. Ask for it again with GET /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.

    Shell
    curl "https://api.enrichednow.com/v1/runs/run_6cce2b12aaf37a10b5e1b885/records?limit=100" \
      -H "Authorization: Bearer $ENRICHEDNOW_API_KEY"
    JSON
    {
      "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#