DeepScout

Scout

Scrape product data from any e-shop and match the same products across shops, without EAN

E-commerce#shopping

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Scrape product data from any e-shop and match the same products across shops, without EAN

Endpoints 38

Account

  • GETGet account info/accountGet current user's profile.
  • PUTUpdate account info/accountUpdate the account name. Returns the account.
  • GETList API keys/account/api-keysList all active API keys for the current user.
  • POSTCreate API key/account/api-keysCreate a new API key. Plaintext is shown once in the response.
  • DELETERevoke API key/account/api-keys/:key_idDeactivate an API key by its id.

Customers

  • GETList customer memberships/customersList the customers the user belongs to, with the user's role in each.
  • GETGet customer/customers/:customer_idGet the customer's name, the user's role and quotas.
  • POSTCreate project/customers/:customer_id/projectsCreate a self-service project owned by the customer.

Billing

  • GETGet prepaid balance/customers/:customer_id/billing/balanceThe customer's prepaid EUR balance. Read-only.
  • GETList job charges of a month/customers/:customer_id/billing/usageThe job charges of one month (YYYY-MM, Europe/Prague), newest first. Without month, the current month. Read-only.
  • GETList top-up invoices/customers/:customer_id/billing/invoicesThe paid top-up invoices of the customer, newest first.
  • GETDownload a top-up invoice PDF/customers/:customer_id/billing/invoices/:invoice_id/pdfThe invoice PDF from the accounting system.
  • POSTStart a prepaid top-up/customers/:customer_id/billing/topupCreate a Stripe Checkout for a prepaid top-up and return its URL.
  • GETGet top-up fulfillment status/customers/:customer_id/billing/topups/:session_idTells if the paid credit of this Checkout session is credited. Read-only.

Projects

  • GETList projects/projectsList the user's projects, default project first.
  • PATCHUpdate project/projects/:project_idRename a project the user administers, or change its localization. A new currency applies to the next exports.

Jobs

  • POSTCancel job/jobs/:job_id/cancelCancel a job before its settlement. The caller cannot cancel an approved scrape job.

Setup Jobs

  • GETList website setup jobs/jobs/setup?project_id=stringList the newest setup jobs of the project, or of one of its websites, with their analysis and training progress. A job without website_id is still looking for…
  • POSTCreate website setup job/jobs/setupCreate a setup job for the URL, country and currency; the analysis starts right away unless the website exists already. An open setup job of the same website…
  • GETGet website setup job/jobs/setup/:job_idReturn one setup job with its analysis progress.
  • DELETERemove website setup job/jobs/setup/:job_idRemove a setup job that never found its website from the project's websites. A job that found one is removed with its website (DELETE /websites/{website_id}).…

Scraping Jobs

  • GETList scraping jobs/jobs/scraping?project_id=stringList the newest scrape jobs of the project, or of one of its websites, with their live scrape progress.
  • POSTCreate scraping job/jobs/scrapingCreate a scrape job with its estimate, awaiting the user's approval. An unfinished FULL scrape job of the website in the project is returned instead, with…
  • GETGet scraping job/jobs/scraping/:job_idGet one scrape job with its live scrape progress.
  • POSTApprove scraping job/jobs/scraping/:job_id/approveApprove a job awaiting approval; dispatches or reuses a scrape. The approval prices the job again at the current metrics. A higher price is refused once with…
  • GETGet scraping job URL results/jobs/scraping/:job_id/url-resultsPresigned URL of the CSV file with the result of each URL of a settled URL job. A row has the url, its result (a UrlResult), and the product_url of its product.

Matching Jobs

  • GETList matching jobs/jobs/matching?project_id=stringList the newest matching jobs of the project with their counters.
  • POSTCreate matching job/jobs/matchingCreate a matching job with its estimate, awaiting the user's approval. The free sample of a project runs at once without approval.
  • GETGet matching job/jobs/matching/:job_idGet one matching job with the counters of its run.
  • POSTApprove matching job/jobs/matching/:job_id/approveApprove a job awaiting approval; dispatches the matching run. The approval prices the job again at the current products. A higher price is refused once with…

Websites

  • GETList websites/websites?project_id=stringList the project's websites, newest first.
  • GETGet website/websites/:website_id?project_id=stringOne website of the project with its live progress; the polling target of the detail page. Its scrape jobs are listed by GET /jobs/scraping.
  • DELETERemove website/websites/:website_id?project_id=stringRemove the website from the project and cancel its idle jobs. Refused while a job of the website is running.

Exports

  • GETList export files/exports?project_id=stringList the export datasets of the project and their files.
  • GETGet export file URL/exports/:dataset/url?project_id=stringPresigned URL of the project's export file for the dataset, optionally of one website.
  • GETGet export file/exports/:datasetDownload an exported dataset. A project-scoped API key gives the project, other credentials name it in project_id.

Samples

  • GETGet product sample file/samples/:website_id?project_id=stringDownload the product sample file of one of the project's websites.

Contact

  • POSTContact sales or support/contact-requestsAsk us to get in touch. The reason selects the team: sales or support. The team contacts you by email, or by phone if you give one. A failed job gives its…

API details

Authentication
A bearer token in the Authorization header
Operations
38 operations on 31 pathsGET 23POST 10DELETE 3PUT 1PATCH 1
Main resources
Billing 6Account 5Scraping Jobs 5Matching Jobs 4Setup Jobs 4Customers 3Exports 3Websites 3Projects 2Contact 1
Response formats
application/json application/pdf
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Scout in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Scout collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get account info” (GET /account), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Scout?

Scrape product data from any e-shop and match the same products across shops, without EAN It is listed under E-commerce and has 38 endpoints.

Who publishes the Scout?

It is listed from DeepScout's public API description (an OpenAPI document), not published by DeepScout on Swastik Codes. Anyone who controls deepscout.ai can claim the profile by adding a DNS TXT record.

How do I authenticate with the Scout?

With A bearer token in the Authorization header.

How many endpoints does the Scout have?

38 operations on 31 paths (23 GET, 10 POST, 3 DELETE, 1 PUT, 1 PATCH). The largest groups are Billing, Account, Scraping Jobs, Matching Jobs.

Is forking the Scout free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.