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.

Usage​

Substitude with {{PUBLIC_TOKEN}} with the project public token found from the project page in Hub and {{API_KEY}} with the generated api key.

The following examples use the httpYac format.

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"]
}

OpenApi​

Check out the generated OpenAPI docs

The OpenAPI schema is available here:

https://api.findkit.com/v1/openapi.json