neutrinoapi v3.4.5

Getting started

The general-purpose API

Initialization

Authentication

In order to setup authentication in the API client, you need the following information.

API client can be initialized as following:

const lib = require('lib');

// Configuration parameters and credentials
lib.Configuration.userId = "userId"; // Your user ID
lib.Configuration.apiKey = "apiKey"; // Your API key

Class Reference

List of Controllers

• Imaging
• Telephony
• DataTools
• SecurityAndNetworking
• Geolocation
• ECommerce
• WWW

Imaging

Get singleton instance

The singleton instance of the Imaging class can be accessed from the API Client.

var controller = lib.Imaging;

imageResize

Resize an image and output as either JPEG or PNG. See: https://www.neutrinoapi.com/api/image-resize/

function imageResize(imageUrl, width, height, format, callback)

Parameters

Example Usage

    var imageUrl = 'image-url';
    var width = 111;
    var height = 111;
    var format = 'format';

    TestHelper.getFileContents('url', function(data) {
        controller.imageResize(imageUrl, width, height, format, function(error, response, context) {

        });
    });

qRCode

Generate a QR code as a PNG image. See: https://www.neutrinoapi.com/api/qr-code/

function qRCode(content, width, height, fgColor, bgColor, callback)

Parameters

Example Usage

    var content = 'content';
    var width = 111;
    var height = 111;
    var fgColor = 'fg-color';
    var bgColor = 'bg-color';

    TestHelper.getFileContents('url', function(data) {
        controller.qRCode(content, width, height, fgColor, bgColor, function(error, response, context) {

        });
    });

imageWatermark

Watermark one image with another image. See: https://www.neutrinoapi.com/api/image-watermark/

function imageWatermark(imageUrl, watermarkUrl, opacity, format, position, width, height, callback)

Parameters

Example Usage

    var imageUrl = 'image-url';
    var watermarkUrl = 'watermark-url';
    var opacity = 111;
    var format = 'format';
    var position = 'position';
    var width = 111;
    var height = 111;

    TestHelper.getFileContents('url', function(data) {
        controller.imageWatermark(imageUrl, watermarkUrl, opacity, format, position, width, height, function(error, response, context) {

        });
    });

hTML5Render

Render HTML content to PDF, JPG or PNG. See: https://www.neutrinoapi.com/api/html5-render/

function hTML5Render(content, format, pageSize, title, margin, marginLeft, marginRight, marginTop, marginBottom, landscape, zoom, grayscale, mediaPrint, mediaQueries, forms, css, imageWidth, imageHeight, renderDelay, headerTextLeft, headerTextCenter, headerTextRight, headerSize, headerFont, headerFontSize, headerLine, footerTextLeft, footerTextCenter, footerTextRight, footerSize, footerFont, footerFontSize, footerLine, pageWidth, pageHeight, callback)

Parameters

Example Usage

    var content = 'content';
    var format = 'format';
    var pageSize = 'page-size';
    var title = 'title';
    var margin = 111;
    var marginLeft = 111;
    var marginRight = 111;
    var marginTop = 111;
    var marginBottom = 111;
    var landscape = false;
    var zoom = 111;
    var grayscale = false;
    var mediaPrint = false;
    var mediaQueries = false;
    var forms = false;
    var css = 'css';
    var imageWidth = 111;
    var imageHeight = 111;
    var renderDelay = 111;
    var headerTextLeft = 'header-text-left';
    var headerTextCenter = 'header-text-center';
    var headerTextRight = 'header-text-right';
    var headerSize = 111;
    var headerFont = 'header-font';
    var headerFontSize = 111;
    var headerLine = false;
    var footerTextLeft = 'footer-text-left';
    var footerTextCenter = 'footer-text-center';
    var footerTextRight = 'footer-text-right';
    var footerSize = 111;
    var footerFont = 'footer-font';
    var footerFontSize = 111;
    var footerLine = false;
    var pageWidth = 111;
    var pageHeight = 111;

    TestHelper.getFileContents('url', function(data) {
        controller.hTML5Render(content, format, pageSize, title, margin, marginLeft, marginRight, marginTop, marginBottom, landscape, zoom, grayscale, mediaPrint, mediaQueries, forms, css, imageWidth, imageHeight, renderDelay, headerTextLeft, headerTextCenter, headerTextRight, headerSize, headerFont, headerFontSize, headerLine, footerTextLeft, footerTextCenter, footerTextRight, footerSize, footerFont, footerFontSize, footerLine, pageWidth, pageHeight, function(error, response, context) {

        });
    });

Back to List of Controllers

Telephony

Get singleton instance

The singleton instance of the Telephony class can be accessed from the API Client.

var controller = lib.Telephony;

verifySecurityCode

Check if a security code from one of the verify APIs is valid. See: https://www.neutrinoapi.com/api/verify-security-code/

function verifySecurityCode(securityCode, callback)

Parameters

Example Usage

    var securityCode = 'security-code';

    controller.verifySecurityCode(securityCode, function(error, response, context) {

    
    });

hLRLookup

Connect to the global mobile cellular network and retrieve the status of a mobile device. See: https://www.neutrinoapi.com/api/hlr-lookup/

function hLRLookup(number, countryCode, callback)

Parameters

Example Usage

    var number = 'number';
    var countryCode = 'country-code';

    controller.hLRLookup(number, countryCode, function(error, response, context) {

    
    });

phonePlayback

Make an automated call to any valid phone number and playback an audio message. See: https://www.neutrinoapi.com/api/phone-playback/

function phonePlayback(number, audioUrl, callback)

Parameters

Example Usage

    var number = 'number';
    var audioUrl = 'audio-url';

    controller.phonePlayback(number, audioUrl, function(error, response, context) {

    
    });

sMSVerify

Send a unique security code to any mobile device via SMS. See: https://www.neutrinoapi.com/api/sms-verify/

function sMSVerify(number, codeLength, securityCode, countryCode, languageCode, callback)

Parameters

Example Usage

    var number = 'number';
    var codeLength = 111;
    var securityCode = 111;
    var countryCode = 'country-code';
    var languageCode = 'language-code';

    controller.sMSVerify(number, codeLength, securityCode, countryCode, languageCode, function(error, response, context) {

    
    });

sMSMessage

Send a free-form message to any mobile device via SMS. See: https://www.neutrinoapi.com/api/sms-message/

function sMSMessage(number, message, countryCode, callback)

Parameters

Example Usage

    var number = 'number';
    var message = 'message';
    var countryCode = 'country-code';

    controller.sMSMessage(number, message, countryCode, function(error, response, context) {

    
    });

phoneVerify

Make an automated call to any valid phone number and playback a unique security code. See: https://www.neutrinoapi.com/api/phone-verify/

function phoneVerify(number, codeLength, securityCode, playbackDelay, countryCode, languageCode, callback)

Parameters

Example Usage

    var number = 'number';
    var codeLength = 111;
    var securityCode = 111;
    var playbackDelay = 111;
    var countryCode = 'country-code';
    var languageCode = 'language-code';

    controller.phoneVerify(number, codeLength, securityCode, playbackDelay, countryCode, languageCode, function(error, response, context) {

    
    });

Back to List of Controllers

DataTools

Get singleton instance

The singleton instance of the DataTools class can be accessed from the API Client.

var controller = lib.DataTools;

emailValidate

Parse, validate and clean an email address. See: https://www.neutrinoapi.com/api/email-validate/

function emailValidate(email, fixTypos, callback)

Parameters

Example Usage

    var email = 'email';
    var fixTypos = false;

    controller.emailValidate(email, fixTypos, function(error, response, context) {

    
    });

userAgentInfo

Parse, validate and get detailed user-agent information from a user agent string. See: https://www.neutrinoapi.com/api/user-agent-info/

function userAgentInfo(userAgent, callback)

Parameters

Example Usage

    var userAgent = 'user-agent';

    controller.userAgentInfo(userAgent, function(error, response, context) {

    
    });

badWordFilter

Detect bad words, swear words and profanity in a given text. See: https://www.neutrinoapi.com/api/bad-word-filter/

function badWordFilter(content, censorCharacter, callback)

Parameters

Example Usage

    var content = 'content';
    var censorCharacter = 'censor-character';

    controller.badWordFilter(content, censorCharacter, function(error, response, context) {

    
    });

convert

A powerful unit conversion tool. See: https://www.neutrinoapi.com/api/convert/

function convert(fromValue, fromType, toType, callback)

Parameters

Example Usage

    var fromValue = 'from-value';
    var fromType = 'from-type';
    var toType = 'to-type';

    controller.convert(fromValue, fromType, toType, function(error, response, context) {

    
    });

phoneValidate

Parse, validate and get location information about a phone number. See: https://www.neutrinoapi.com/api/phone-validate/

function phoneValidate(number, countryCode, ip, callback)

Parameters

Example Usage

    var number = 'number';
    var countryCode = 'country-code';
    var ip = 'ip';

    controller.phoneValidate(number, countryCode, ip, function(error, response, context) {

    
    });

Back to List of Controllers

SecurityAndNetworking

Get singleton instance

The singleton instance of the SecurityAndNetworking class can be accessed from the API Client.

var controller = lib.SecurityAndNetworking;

iPProbe

Analyze and extract provider information for an IP address. See: https://www.neutrinoapi.com/api/ip-probe/

function iPProbe(ip, callback)

Parameters

Example Usage

    var ip = 'ip';

    controller.iPProbe(ip, function(error, response, context) {

    
    });

emailVerify

SMTP based email address verification. See: https://www.neutrinoapi.com/api/email-verify/

function emailVerify(email, fixTypos, callback)

Parameters

Example Usage

    var email = 'email';
    var fixTypos = false;

    controller.emailVerify(email, fixTypos, function(error, response, context) {

    
    });

iPBlocklist

The IP Blocklist API will detect potentially malicious or dangerous IP addresses. See: https://www.neutrinoapi.com/api/ip-blocklist/

function iPBlocklist(ip, callback)

Parameters

Example Usage

    var ip = 'ip';

    controller.iPBlocklist(ip, function(error, response, context) {

    
    });

hostReputation

Check the reputation of an IP address, domain name, FQDN or URL against a comprehensive list of blacklists and blocklists. See: https://www.neutrinoapi.com/api/host-reputation/

function hostReputation(host, listRating, callback)

Parameters

Example Usage

    var host = 'host';
    var listRating = 111;

    controller.hostReputation(host, listRating, function(error, response, context) {

    
    });

Back to List of Controllers

Geolocation

Get singleton instance

The singleton instance of the Geolocation class can be accessed from the API Client.

var controller = lib.Geolocation;

geocodeReverse

Convert a geographic coordinate (latitude and longitude) into a real world address. See: https://www.neutrinoapi.com/api/geocode-reverse/

function geocodeReverse(latitude, longitude, languageCode, zoom, callback)

Parameters

Example Usage

    var latitude = 'latitude';
    var longitude = 'longitude';
    var languageCode = 'language-code';
    var zoom = 'zoom';

    controller.geocodeReverse(latitude, longitude, languageCode, zoom, function(error, response, context) {

    
    });

iPInfo

Get location information about an IP address and do reverse DNS (PTR) lookups. See: https://www.neutrinoapi.com/api/ip-info/

function iPInfo(ip, reverseLookup, callback)

Parameters

Example Usage

    var ip = 'ip';
    var reverseLookup = false;

    controller.iPInfo(ip, reverseLookup, function(error, response, context) {

    
    });

geocodeAddress

Geocode an address, partial address or just the name of a place. See: https://www.neutrinoapi.com/api/geocode-address/

function geocodeAddress(address, countryCode, languageCode, fuzzySearch, callback)

Parameters

Example Usage

    var address = 'address';
    var countryCode = 'country-code';
    var languageCode = 'language-code';
    var fuzzySearch = false;

    controller.geocodeAddress(address, countryCode, languageCode, fuzzySearch, function(error, response, context) {

    
    });

Back to List of Controllers

ECommerce

Get singleton instance

The singleton instance of the ECommerce class can be accessed from the API Client.

var controller = lib.ECommerce;

bINLookup

Perform a BIN (Bank Identification Number) or IIN (Issuer Identification Number) lookup. See: https://www.neutrinoapi.com/api/bin-lookup/

function bINLookup(binNumber, customerIp, callback)

Parameters

Example Usage

    var binNumber = 'bin-number';
    var customerIp = 'customer-ip';

    controller.bINLookup(binNumber, customerIp, function(error, response, context) {

    
    });

Back to List of Controllers

WWW

Get singleton instance

The singleton instance of the WWW class can be accessed from the API Client.

var controller = lib.WWW;

uRLInfo

Parse, analyze and retrieve content from the supplied URL. See: https://www.neutrinoapi.com/api/url-info/

function uRLInfo(url, fetchContent, ignoreCertificateErrors, timeout, callback)

Parameters

Example Usage

    var url = 'url';
    var fetchContent = false;
    var ignoreCertificateErrors = false;
    var timeout = 111;

    controller.uRLInfo(url, fetchContent, ignoreCertificateErrors, timeout, function(error, response, context) {

    
    });

hTMLClean

Clean and sanitize untrusted HTML. See: https://www.neutrinoapi.com/api/html-clean/

function hTMLClean(content, outputType, callback)

Parameters

Example Usage

    var content = 'content';
    var outputType = 'output-type';

    TestHelper.getFileContents('url', function(data) {
        controller.hTMLClean(content, outputType, function(error, response, context) {

        });
    });

browserBot

Browser bot can extract content, interact with keyboard and mouse events, and execute JavaScript on a website. See: https://www.neutrinoapi.com/api/browser-bot/

function browserBot(url, timeout, delay, selector, exec, userAgent, ignoreCertificateErrors, callback)

Parameters

Example Usage

    var url = 'url';
    var timeout = 111;
    var delay = 111;
    var selector = 'selector';
    var exec = ['exec'];
    var userAgent = 'user-agent';
    var ignoreCertificateErrors = false;

    controller.browserBot(url, timeout, delay, selector, exec, userAgent, ignoreCertificateErrors, function(error, response, context) {

    
    });

Back to List of Controllers