Skip to content
looot docs
Esc
↑↓navigate↵open⌘Jpreview
On this page

catalog_overview

Free tool for what the catalog covers, as categories, platforms and jobs, with counts and cheapest prices at every level.

What exists in the catalog, as categories > platforms > jobs, with counts at every level: providerCount, endpointCount, runnableCount (runnable without your own key), and cheapestPerCall / cheapestPerResult (the two are never compared against each other). Free and read-only. Same body as GET /v1/catalog/overview with the same arguments.

Inputs

Argument Type Required Default Limits Meaning
depth string No summary, or platforms when category/platform is given summary | platforms | jobs | full How deep to expand. Not combined with topic.
category string No - - A category id from the summary. Answers only that category.
platform string No - - A platform id from depth: platforms. Answers only that platform, inside its category.
topic string No - - Words like “email” or “phone number”. Answers the matching jobs, at most 25, truncated: true when there are more.

No arguments returns a summary: totals plus one line per category, a few KB. depth: jobs on a big category such as “other” can run to hundreds of KB, so prefer topic when you just want to find a job id. Unknown ids answer unknown_category or unknown_platform.

Example call

{
  "topic": "email"
}

Example answer

Abridged: a full topic answer can list up to 25 jobs.

{
  "topic": "email",
  "jobs": [
    {
      "id": "people.email.find",
      "title": "Find a work email from a name and domain",
      "category": "enrichment",
      "providerCount": 9,
      "endpointCount": 14,
      "runnableCount": 14,
      "cheapestPerCall": 0.0036,
      "cheapestPerResult": 0.019
    },
    {
      "id": "people.email.verify",
      "title": "Verify an email address is deliverable",
      "category": "enrichment",
      "providerCount": 7,
      "endpointCount": 9,
      "runnableCount": 9,
      "cheapestPerCall": 0.0019,
      "cheapestPerResult": null
    }
  ],
  "truncated": false
}

Errors

Free and read-only; no runs.execute needed. An unknown category or platform answers unknown_category or unknown_platform, not a generic validation_error.

REST and CLI

Was this page helpful?