Platinux API

POST/api-company-bulk

Company details in bulk

Company details for up to 1,000 domains in one call.

View as Markdown

Request

bash
curl -X POST "https://mmkuffhlzytnmgraagbp.supabase.co/functions/v1/api-company-bulk" \
  -H "Authorization: Bearer $PLATINUX_API_KEY" -H "Content-Type: application/json" \
  -d '{"domains": ["miro.com", "loom.com", "airtable.com"]}'
Body fieldTypeRequiredNotes
domainsarray of stringsYes1 to 1,000 domains

How it answers depends on the size of the list:

DomainsAnswer
Up to 100Results straight away, 200
101 to 1,000202 with a batch_id; collect the results with GET. Usually ready within a minute

Up to 100 domains: 200

json
{ "status": "complete", "total": 3, "found": 3, "not_found": 0, "credits_charged": 2,
  "rejected": [],
  "results": [
    { "domain": "miro.com", "status": "found", "company": { "name": "Miro", "…": "…" }, "domain_match": true, "cached": false, "credits_charged": 1 },
    { "domain": "loom.com", "status": "found", "company": { "name": "Loom", "…": "…" }, "domain_match": true, "cached": false, "credits_charged": 1 },
    { "domain": "airtable.com", "status": "found", "company": { "name": "Airtable", "…": "…" }, "domain_match": true, "cached": true, "credits_charged": 0 } ] }

Each company has the same fields as api-company. A not-found item:

json
{ "domain": "zz-unknown.com", "status": "not_found", "company": null, "domain_match": null, "cached": false, "credits_charged": 0 }

101 to 1,000 domains

Started: 202

json
{ "status": "processing", "batch_id": "7c2f…", "total": 640, "rejected": [ { "domain": "x.com/acme", "reason": "invalid_domain" } ], "check_after_seconds": 30 }

Check

bash
curl "https://mmkuffhlzytnmgraagbp.supabase.co/functions/v1/api-company-bulk?batch_id=7c2f…&page=1" -H "Authorization: Bearer $PLATINUX_API_KEY"

Still running, 202:

json
{ "status": "processing", "batch_id": "7c2f…", "total": 640 }

Done, 200, 100 results per page:

json
{ "status": "complete", "batch_id": "7c2f…", "total": 640, "found": 598, "not_found": 42, "credits_charged": 571,
  "results": [ { "domain": "…", "status": "found", "…": "…" } ], "page": 1, "pages": 7 }

Failed (data source down), 200, nothing charged:

json
{ "status": "failed", "batch_id": "7c2f…", "total": 640, "error": "provider_unavailable", "message": "nothing was charged; start again" }

Credits

1 credit per company found. Cached (looked up in the last 30 days) and not-found domains are free. Credits are checked up front for the domains not in the cache.

Errors

HTTPerrorWhen
400invalid_inputdomains missing or empty
400invalid_domainNo usable domain in the list
400too_many_domainsMore than 1,000 domains
401unauthorizedMissing, wrong or revoked key
402insufficient_creditsNot enough credits for the domains not in the cache
404batch_not_foundWrong batch_id, or another account's batch
502provider_unavailableThe data source didn't answer. Nothing was charged