CrawlHawk API

The CrawlHawk API lets you start crawls and retrieve results programmatically, so you can build crawling and link analysis directly into your own tools and workflows. This overview covers the essentials; the full reference is available in your account.

Getting Started

Using the API takes just a few steps:

• Generate an API key: create a key from your CrawlHawk account when you are signed in.
• Authenticate: send your key as a Bearer token with your requests to authorize them.
• Start a crawl: trigger a crawl for a target website through the API.
• Retrieve results: fetch the crawl output and work with the extracted links and site data in your own application.

Building With CrawlHawk

The API returns the same link and structure data you would see in the app, including internal, external, broken, orphan, file, and image links, so you can automate audits, feed results into dashboards, or schedule recurring crawls. Results can be worked with in the export formats CrawlHawk supports, making integration straightforward.

Keep your API key private, as it authorizes crawls on your account. For complete details on requests, parameters, and responses, refer to the full API reference available in your CrawlHawk account.

If you have not tried CrawlHawk yet, you can crawl up to 500 URLs free with no credit card required. Sign in, generate your key, and start automating your crawls today.