Skip to main content
Use Neutrino API through Corsair: one client, typed API calls. Neutrino needs two credentials on every call: the account’s numeric user id and one of its API keys. Both are on https://www.neutrinoapi.com/account/. The plugin sends them combined in a single API-Key header as user-id:api-key, which is the form Neutrino documents, so neither lands in a query string. Set both before the first call, for example pnpm corsair setup --plugin=neutrino --tenant=acme api_key=<key> user_id=<id>, or pass key and userId in the plugin options. What each group does:
  • IP. ip.info geolocates an address, ip.blocklist checks the blocklists Neutrino tracks with a flag per threat type, and ip.probe reports the hosting provider rather than the place.
  • Email. email.validate checks syntax, domain and MX without contacting the mailbox. email.verify adds an SMTP probe and reports verified separately from valid, because a server can accept a domain and still refuse the mailbox check.
  • Phone. phone.validate parses a number into its international and local forms with the carrier prefix. phone.hlrLookup queries the carrier’s home location register for whether the number is live and whether it was ported.
  • Web. web.uaLookup parses a User-Agent, web.domainLookup reads domain facts and blocklists, web.hostReputation checks a host against many DNSBLs, web.urlInfo inspects a URL, and web.browserBot loads a page in a real browser and can run JavaScript on it.
  • Text. text.badWordFilter finds profanity in text and returns a censored copy.
  • Geocode, commerce. Forward and reverse geocoding, card BIN facts, and unit and currency conversion.
  • Messaging. messaging.smsVerify texts a security code and messaging.phoneVerify reads one out in a call; messaging.verifySecurityCode checks the code the person types.
Worth knowing before you call:
  • web.urlInfo and the phone HLR lookup make Neutrino do outside work. The first fetches the page themselves, and the second queries a carrier, so both cost more and can fail on a target that refuses them.
  • messaging.smsVerify and messaging.phoneVerify reach a real person and spend credits, so both are destructive. Neutrino keeps the code it sent, and messaging.verifySecurityCode checks what the person types. A 5xx on these routes is never retried, because the message or call may already have gone out.
  • messaging.verifySecurityCode is write. With limitBy, each failed check counts toward a lockout for that identifier.
  • web.browserBot is write. Loading a page only reads, but its exec statements run on the third-party page and can click or submit forms there.
  • Parameters are hyphenated. country-code, bin-number, from-value, fetch-content, code-length. The plugin maps its own camelCase inputs onto those names, so a caller writes countryCode and binNumber.
  • A convert result comes twice. result is a string and result-float a number; use the one the surrounding code needs rather than parsing the first.
Errors are { "api-error": <number>, "api-error-msg": "..." }. Code 43 is the credential check, and it is the only code that means a bad user id or key; a 403 with another code is a plan or permission limit. A route that does not exist answers 400 with code 45 even without credentials. What you get:
  • 20 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

4

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

Example API calls

Geolocate a public address
Send a security code by SMS
See the full list on the API page.

What’s next

API reference

Every neutrino.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.