Geonode
API ReferenceGuidesScraper APIChange Log
Getting started

Before You Start

This guide covers the basic requirements needed to follow the Extraction guides and ensure your account is set up and ready to make requests.

Prerequisites

Create a Geonode Account

Sign up for a Geonode account if you do not already have one.

Get Access to the Scraper API

Make sure your account has access to the Scraper API.

Generate an API Key

  1. Go to https://app.geonode.com/scraper-api.
  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

Include your API key in the X-Api-Key request header.

X-Api-Key: YOUR_API_KEY

Requests without a valid API key will be rejected.

Base URL

All Extraction API endpoints are available through the following base URL:

https://scraper.geonode.io

Next Steps

Now that your account is set up, continue to Understanding Extraction to learn how the Extraction API works and when to use its different features.

Map URLs

Discover URLs from a base URL using sitemap parsing and HTML link extraction.

Output Formats

Learn how to return content as Markdown, HTML, or both formats in a single extraction request.

On this page

PrerequisitesCreate a Geonode AccountGet Access to the Scraper APIGenerate an API KeyAuthenticationBase URLNext Steps