Platinux API

Introduction

What the Platinux API does, how to call it, and every endpoint at a glance.

View as Markdown

The Platinux API lets your own systems do what the Platinux app does: score a company by its buying signals, look up company details and find the company behind an email address. Everything works with one API key, and uses the same templates and credits as your Platinux account.

The flow: template first, then score

Every score needs a template, so the order is always the same:

  1. Get an API key at platinux.net/dashboard/score.
  2. Get your template. Call GET api-templates and take the template_id with "is_live": true. The template decides which buying signals count towards the score.
  3. Score, passing that template_id: a domain, email or LinkedIn URL with /score/domain, /score/email or /score/social, or a whole list with /score/…/bulk. Scoring runs in the background: you start a job, then check back for the score.
  4. Add company details with api-company whenever you need them.

Use cases

You want toStart here
Reach out first to the target accounts most likely to buyB2B sales outreach
Give your best-fit form fills and demo requests the fastest pathConversion rate optimisation
Find the signups worth a sales conversationIdentify good leads from signups

Base URL

https://mmkuffhlzytnmgraagbp.supabase.co/functions/v1

Every request uses HTTPS and JSON. Send your API key in the Authorization header (see Authentication).

Endpoints

Scoring: start with whatever you have (each call needs a template_id from api-templates):

EndpointWhat you sendCredits
POST /score/domainA company website10
POST /score/emailA company, work or generic email10 (generic 20)
POST /score/socialA LinkedIn company page or person profile10
POST /score/…/bulkUp to 1,000 of the abovePer input
GET api-templatesLists your scoring templatesFree

Anything that ends without a score costs 0.

Company data:

EndpointWhat it doesCredits
api-company / -bulkCompany details for a domain (up to 1,000)1 when found
api-email-domain / -bulkThe company domain behind an email (up to 1,000)0, or 10 for a generic email found

New here? The Quickstart gets you from a new key to your first score in a few minutes.

For AI tools

These docs are plain to read for people and for AI assistants: