Authentication & Base URL

Web Data

Set up access to the Geonode Scraper API, generate an API key, and learn how to authenticate requests.

Prerequisites

Before making your first request, complete the following steps.

Create a Geonode Account

Sign up for a Geonode account or log in if you already have one.

Get Access to the Scraper API

Make sure your account has access to the Scraper API.

Generate Your API Key

  1. Go to the Scraper API Dashboard.
  2. Click Get Code.
  3. The API & Integrations modal will open.
  4. Click Copy API Key to copy your API key.

API & Integrations Modal

Authentication

All Scraper API requests require an API key in the X-Api-Key request header.

X-Api-Key: YOUR_API_KEY
export GEONODE_SCRAPER_API_KEY="YOUR_API_KEY"

Replace YOUR_API_KEY with your actual API key. Requests without a valid API key will be rejected.

Keep your API key private. Do not put it in frontend apps, public repos, screenshots, or logs.

Base URL

Use the following base URL for Scraper API requests:

https://scraper.geonode.io
export SCRAPER_API_BASE_URL="https://scraper.geonode.io"

Was this page helpful?