API Basics
★  Fundamentals
★  Error Codes
★  Examples
★  Batch Processing
★  Specifications
★  Best Practice
★  SDKs
★  Stats
Data Tools
WWW
Telephony
Geolocation
Security and Networking
E-commerce
Imaging

API Fundamentals


Neutrino API is a "RESTful" style API and will accept request parameters as either HTTP GET or HTTP POST

When sending API requests as HTTP POST we accept two content types:

The API is case agnostic, meaning "user-id", "userId" and "user_id" are all treated as the same.

Authentication

All API requests must be authenticated using an API key and your user ID.
The following authentication parameters can be sent with POST, GET or as HTTP headers:

API ParameterDescription
user-idYour user ID
api-keyAPI key, generate keys within your account

Structured Responses

Most APIs will return structured data, you can set these optional output parameters:

API ParameterDescription
output-format Which data format the API should respond with, can be either:
  • JSON (default)
  • XML
output-case The case style to respond with:
  • kebab (default)
  • camel
  • snake

Binary Responses

Some APIs can return binary and text based file formats, such as: PNG, PDF, MP3, HTML, SVG.
For these APIs the HTTP 'Content-Type' header will be set with the appropriate MIME type.

Further Reading...

API Examples
API Specification
API Error Codes


API INDEX


API Basics
Data Tools
WWW
Telephony
Geolocation
Security and Networking
E-commerce
Imaging