# Introduction

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

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](https://platinux.net/dashboard/score).
2. **Get your template.** Call [`GET api-templates`](/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-domain), [`/score/email`](/score-email) or [`/score/social`](/score-social), or a whole list with [`/score/…/bulk`](/score-list). Scoring runs in the background: you start a job, then check back for the score.
4. **Add company details** with [`api-company`](/company) whenever you need them.

## Use cases

| You want to | Start here |
|---|---|
| Reach out first to the target accounts most likely to buy | [B2B sales outreach](/b2b-sales-outreach) |
| Give your best-fit form fills and demo requests the fastest path | [Conversion rate optimisation](/conversion-rate-optimisation) |
| Find the signups worth a sales conversation | [Identify good leads from signups](/signup-lead-qualification) |

## Base URL

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

Every request uses HTTPS and JSON. Send your API key in the `Authorization` header (see [Authentication](/authentication)).

## Endpoints

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

| Endpoint | What you send | Credits |
|---|---|---|
| [`POST /score/domain`](/score-domain) | A company website | 10 |
| [`POST /score/email`](/score-email) | A company, work or generic email | 10 (generic 20) |
| [`POST /score/social`](/score-social) | A LinkedIn company page or person profile | 10 |
| [`POST /score/…/bulk`](/score-list) | Up to 1,000 of the above | Per input |
| [`GET api-templates`](/templates) | Lists your scoring templates | Free |

Anything that ends without a score costs **0**.

**Company data**:

| Endpoint | What it does | Credits |
|---|---|---|
| [`api-company`](/company) / [`-bulk`](/company-bulk) | Company details for a domain (up to 1,000) | 1 when found |
| [`api-email-domain`](/email-domain) / [`-bulk`](/email-domain-bulk) | The company domain behind an email (up to 1,000) | 0, or 10 for a generic email found |

New here? The [Quickstart](/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:

- [`/llms.txt`](/llms.txt): an index of every page.
- [`/llms-full.txt`](/llms-full.txt): the whole documentation in one Markdown file.
- Add `.md` to any page address for its Markdown, for example [`/score-domain.md`](/score-domain.md).
- [`/openapi.json`](/openapi.json): the OpenAPI 3.1 description of every endpoint.
