# Self-service API (/api)

The DeepScout API gives you the same functions as the [DeepScout Console](https://console.deepscout.ai). You add a website, look at free sample data, approve a scrape, match products across websites and download the results as files.

```txt title="Base URL"
https://api.deepscout.ai/v1
```

## How it works [#how-it-works]

The API follows the same flow as the console. Each step is a **job** that runs in the background. You start a job with a `POST` request and read its status with a `GET` request.

<Steps>
<Step>

### Add a website [#add-a-website]

A setup job analyzes the website and learns how to read its product pages. The setup is free and gives you sample products. See [Add a website](/api/add-website.md).

</Step>
<Step>

### Look at the sample data [#look-at-the-sample-data]

Before you pay, download up to 1,000 sample products and make sure that the data is correct. See [Check the sample data](/api/sample-data.md).

</Step>
<Step>

### Scrape the full catalog [#scrape-the-full-catalog]

You get a price estimate for the full catalog. When you approve it, the scrape starts and the cost comes from your prepaid credit. See [Scrape the full catalog](/api/full-scrape.md).

</Step>
<Step>

### Update prices with URL lists [#update-prices-with-url-lists]

Send a list of product URLs to update only these products. You can also scrape a URL list without the full catalog. See [Scrape a URL list](/api/url-scrape.md).

</Step>
<Step>

### Match products across websites [#match-products-across-websites]

A matching job finds the same products on different websites. Start with a free sample. See [Match products](/api/matching.md).

</Step>
<Step>

### Download the exports [#download-the-exports]

Each completed scrape or matching updates the export files of the project. Download them as gzipped JSON Lines. See [Download exports](/api/exports.md).

</Step>
</Steps>

## Start here [#start-here]

<Cards>
  <Card title="Quickstart" href="/api/quickstart.md">
    Get an API key and send your first requests.
  </Card>
  <Card title="Core concepts" href="/api/concepts.md">
    Customers, projects, websites, jobs and credit.
  </Card>
  <Card title="MCP server" href="/api/mcp.md">
    Connect Claude, Cursor, Codex and other AI agents.
  </Card>
  <Card title="End-to-end example" href="/api/example.md">
    One Python script for the full flow, from a URL to the exports.
  </Card>
  <Card title="Endpoints" href="/api/reference/websites/list-websites.md">
    All endpoints with their parameters, responses and code samples.
  </Card>
</Cards>

## What you pay for [#what-you-pay-for]

Sample data is free. The first 10 setup jobs of each month are free, and each next one costs €0.50. Setup jobs, scrapes and matchings use prepaid credit in EUR. Each scrape and matching shows a quote before it starts, and the final charge is never more than 1.5 times the estimate. See [Pricing](/api/pricing.md) and [Credits and billing](/api/credits.md).

<Callout title="OpenAPI specification">
The machine-readable specification is at [`https://api.deepscout.ai/v1/openapi.json`](https://api.deepscout.ai/v1/openapi.json). Use it to generate a client in your language.
</Callout>