# Neutrino API

> Neutrino API is a collection of general-purpose APIs that solve common but recurring problems in software
> development: data validation, telephony, geolocation, security/networking, e-commerce and imaging. It is a
> single flat REST-style HTTP API — 28 published operations, one verb path each, no resources, no state.
> Authenticated with two headers: `user-id` and `api-key`. Bootstrapped, Auckland New Zealand, operating since
> 2013, serving 800M+ requests/day.

Generated by API Evangelist from the provider's published OpenAPI 3.1 definition and documentation on
2026-08-09. Neutrino API does not publish an llms.txt of its own (https://www.neutrinoapi.com/llms.txt → 404).

## Before you call it

- Base URL: `https://neutrinoapi.net` (default multicloud anycast endpoint).
- Auth: send BOTH `user-id` and `api-key` as HTTP headers, or combined as `API-Key: <user-id>:<api-key>`.
  They may also be sent as query params or form fields. Get keys at https://www.neutrinoapi.com/account/login/.
- GET or POST — most endpoints accept either. POST bodies may be `application/x-www-form-urlencoded`,
  `application/json` or `multipart/form-data`.
- Responses default to JSON in kebab-case. Set `output-format=XML` or `output-case=camel|snake` to change it.
  If you generate parsing code, pin `output-case` explicitly — field names change with it.
- Errors are NOT RFC 9457. A failure returns HTTP 400 (or 403 for auth, 500 for faults) with
  `{"api-error": <int>, "api-error-msg": "<string>"}`. Branch on the integer, not the status code.
  Full code table: https://www.neutrinoapi.com/api/api-errors/
- There is no API version to pin, no rate-limit response headers, and no request id. Quota is a rolling
  24-hour per-endpoint daily allowance that resets 24h after your first call of the day.
- Batch up to 2500 lookups in one call by POSTing JSON to `https://neutrinoapi.net/multi` with a `data` array
  whose elements each carry an `endpoint` field. Not on the free plan, and NOT in the OpenAPI.
- Endpoint choice is the compliance control: `eu.`, `aus.` and `usa.neutrinoapi.net` guarantee in-boundary
  processing; `aws.` and `gcp.neutrinoapi.net` pin a single cloud.

## Machine-readable definitions

- [OpenAPI 3.1 (JSON)](https://www.neutrinoapi.com/api/openapi-3.1.json)
- [OpenAPI 3.1 (YAML)](https://www.neutrinoapi.com/api/openapi-3.1.yaml)
- [Swagger 2.0 (JSON)](https://www.neutrinoapi.com/api/swagger.json)
- [Postman collection](https://www.neutrinoapi.com/api/postman.json)
- [Insomnia collection](https://www.neutrinoapi.com/api/insomnia.json)
- [RAML](https://www.neutrinoapi.com/api/raml.yaml) / [WADL](https://www.neutrinoapi.com/api/wadl.xml) / [WSDL](https://www.neutrinoapi.com/api/wsdl.xml) / [API Blueprint](https://www.neutrinoapi.com/api/apiblueprint.md)
- [RFC 9727 API catalog](https://www.neutrinoapi.com/.well-known/api-catalog): the machine-readable front door
- [Specification page](https://www.neutrinoapi.com/api/specification/)

## Docs

- [API Fundamentals](https://www.neutrinoapi.com/api/api-basics/): auth, content types, output format and case
- [API Index](https://www.neutrinoapi.com/api/index/): every endpoint, grouped
- [Error Codes](https://www.neutrinoapi.com/api/api-errors/): the numeric `api-error` table, server and SDK side
- [Batch Processing](https://www.neutrinoapi.com/api/batch-processing/): the `/multi` endpoint
- [Multicloud / Geofence](https://www.neutrinoapi.com/api/multicloud/): the seven endpoint hostnames
- [Best Practice](https://www.neutrinoapi.com/api/best-practice/): key scoping, timeouts, retries, pooling
- [API Examples](https://www.neutrinoapi.com/api/api-examples/): working code in 9 languages
- [SDKs](https://www.neutrinoapi.com/api/sdks/): 11 first-party clients, release line v4.7.1
- [Plans and quotas](https://www.neutrinoapi.com/plans/): per-endpoint daily limits, free tier, on-demand rates
- [Updates](https://www.neutrinoapi.com/updates/) ([RSS](https://www.neutrinoapi.com/updates/rss/)): the change log
- [Status](https://status.neutrinoapi.com/): Atlassian Statuspage, with `/api/v2/status.json`

## Operations — Data Tools

- `EmailValidate` GET /email-validate: Parse, validate and clean an email address
- `PhoneValidate` GET /phone-validate: Parse, validate and get location information about a phone number
- `UALookup` GET /ua-lookup: Parse, validate and get detailed user-agent information from a UA string or client hints
- `BadWordFilter` POST /bad-word-filter: Detect bad words, swear words and profanity in a given text

## Operations — Security and Networking

- `IPBlocklist` GET /ip-blocklist: Detect potentially malicious or dangerous IP addresses
- `IPProbe` GET /ip-probe: Execute a realtime network probe against an IPv4 or IPv6 address
- `HostReputation` GET /host-reputation: Check an IP, domain or URL against a comprehensive list of blacklists
- `DomainLookup` GET /domain-lookup: Retrieve domain details and detect potentially malicious domains
- `EmailVerify` GET /email-verify: SMTP-based email address verification
- `IPBlocklistDownload` GET /ip-blocklist-download: Direct feed of the IP blocklist data

## Operations — Geolocation

- `IPInfo` GET /ip-info: Location information about an IP address, plus optional reverse DNS (PTR)
- `GeocodeAddress` GET /geocode-address: Geocode an address, partial address or place name
- `GeocodeReverse` GET /geocode-reverse: Convert a latitude/longitude into a real-world address

## Operations — Telephony (these cost money per call and have real-world side effects)

- `PhoneVerify` POST /phone-verify: Automated call playing back a unique security code
- `SMSVerify` POST /sms-verify: Send a unique security code to a mobile device via SMS
- `VerifySecurityCode` GET /verify-security-code: Check whether a code from SMS/Phone Verify is valid
- `PhonePlayback` POST /phone-playback: Automated call playing back an audio message
- `HLRLookup` GET /hlr-lookup: Query the global mobile network for the live status of a mobile device

## Operations — E-commerce

- `BINLookup` GET /bin-lookup: BIN/IIN lookup (6, 8, 10 and 12 digit BINs)
- `Convert` GET /convert: Currency and unit conversion, including historical FX via `historical-date`
- `BINListDownload` GET /bin-list-download: Download the entire BIN database

## Operations — WWW

- `URLInfo` GET /url-info: Parse, analyze and retrieve content from a URL
- `HTMLClean` POST /html-clean: Clean and sanitize untrusted HTML
- `BrowserBot` POST /browser-bot: Extract content, drive keyboard/mouse events and execute JavaScript on a site

## Operations — Imaging

- `HTMLRender` POST /html-render: Render HTML to PDF, JPG or PNG (Chromium)
- `ImageResize` POST /image-resize: Resize an image, output JPEG or PNG
- `ImageWatermark` POST /image-watermark: Watermark one image with another
- `QRCode` POST /qr-code: Generate a QR code (or a C128 barcode via `code-format`) as a PNG

## Deprecated — do not build on these

`user-agent-info` (use `UALookup`), `html5-render` (use `HTMLRender`), `sms-message` (use `SMSVerify`),
`html-extract-tags` (use `HTMLClean` / `BrowserBot`), `code-highlight`. They are absent from the OpenAPI and
signalled only by a docs banner; on the wire a retired endpoint returns `api-error: 18`.

## Not available

No webhooks, no events, no streaming, no GraphQL, no gRPC. No OAuth. No MCP server, no agent card, no packaged
agent skills, and no provider-published llms.txt. No SOC 2 or ISO 27001 — compliance is a published DPA plus
stated EU GDPR / UK GDPR / New Zealand Privacy Act 2020 conformance.

## API Evangelist artifacts for this provider

- `openapi/neutrino-api-openapi-3.1.json`, `openapi/neutrino-api-swagger-2.0.json`
- `conventions/neutrino-api-conventions.yml` — auth, batching, casing, quotas, endpoint selection
- `errors/neutrino-api-problem-types.yml` — the full numeric error catalog
- `lifecycle/neutrino-api-lifecycle.yml`, `changelog/neutrino-api-changelog.yml`
- `authentication/neutrino-api-authentication.yml`, `security/neutrino-api-domain-security.yml`
- `conformance/neutrino-api-conformance.yml`, `data-model/neutrino-api-data-model.yml`
- `packages/neutrino-api-packages.yml`, `well-known/neutrino-api-well-known.yml`
- `mcp/neutrino-api-mcp.yml` (candidate, derived — not published by the provider)
- `skills/` — packaged agent skills grounded in the real operationIds