Skip to main content

REST API

The REST API can be used to start crawls.

API Keys​

Go to your project in the Findkit Hub and generate the API KEY in Settings -> API Keys.

API Endpoints​

Check out the generated OpenAPI docs. The OpenAPI schema is available here

Full Crawl​

Start a full crawl.

POST https://api.findkit.com/v1/projects/{{PUBLIC_TOKEN}}/crawls
Content-Type: application/json
Authorization: Bearer {{API_KEY}}

{
    "mode": "full",
}

Partial Crawl​

Start a partial crawl.

POST https://api.findkit.com/v1/projects/{{PUBLIC_TOKEN}}/crawls
Content-Type: application/json
Authorization: Bearer {{API_KEY}}

{
    "mode": "partial",
}

Manual Crawl​

Start a manual crawl.

POST https://api.findkit.com/v1/projects/{{PUBLIC_TOKEN}}/crawls
Content-Type: application/json
Authorization: Bearer {{API_KEY}}

{
    "mode": "manual",
    "urls": ["https://www.example.com/page"]
}

Usage​

The above examples use the httpYac format. To run them using it save the examples to a file with a .http extension and run the following command:

httpyac send example.http --var API_KEY=aJxryVb:sJLe5Crb2op5Bld2hTqdvlj7y --var PUBLIC_TOKEN=p2nGrEaD7:eu-north-1

using your own API_KEY and PUBLIC_TOKEN.

Or just manually build the request for your favorite HTTP client replacing {{API_KEY}} and {{PUBLIC_TOKEN}} with your own values.

Here's an example with curl:

curl --fail-with-body --data '{"mode": "full"}' -H 'content-type: application/json' -H "Authorization: Bearer aJxryVb:sJLe5Crb2op5Bld2hTqdvlj7y"  https://api.findkit.com/v1/projects/p2nGrEaD7:eu-north-1/crawls