openapi-directory/api/neutrinoapi.net.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://neutrinoapi.net"}],"info":{"contact":{"email":"ops@neutrinoapi.com","name":"Neutrino API","url":"https://www.neutrinoapi.com/"},"description":"The general-purpose API","title":"Neutrino API","version":"3.6.4","x-apisguru-categories":["email","messaging","telecom","location","text"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://www.neutrinoapi.com/img/NEUTRINO_LOGO_NOBG_126x65.png"},"x-origin":[{"format":"openapi","url":"https://www.neutrinoapi.com/api/swagger.json","version":"3.0"}],"x-providerName":"neutrinoapi.net"},"security":[{"api-key":[],"user-id":[]}],"tags":[{"description":"","name":"Imaging"},{"description":"","name":"Telephony"},{"description":"","name":"Data Tools"},{"description":"","name":"Security and Networking"},{"description":"","name":"Geolocation"},{"description":"","name":"E-commerce"},{"description":"","name":"WWW"}],"paths":{"/bad-word-filter":{"post":{"deprecated":false,"description":"Detect bad words, swear words and profanity in a given text","operationId":"BadWordFilter","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"catalog":{"default":"strict","description":"Which catalog of bad words to use, we currently maintain two bad word catalogs: <br> <ul> <li>strict - the largest database of bad words which includes profanity, obscenity, sexual, rude, cuss, dirty, swear and objectionable words and phrases. This catalog is suitable for environments of all ages including educational or children's content</li> <li>obscene - like the strict catalog but does not include any mild profanities, idiomatic phrases or words which are considered formal terminology. This catalog is suitable for adult environments where certain types of bad words are considered OK</li> </ul>","type":"string"},"censor-character":{"description":"The character to use to censor out the bad words found","type":"string"},"content":{"description":"The content to scan. This can be either a URL to load from, a file upload (multipart/form-data) or an HTML content string","type":"string"}},"required":["content"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadWordFilterResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Bad Word Filter","tags":["Data Tools"]}},"/bin-list-download":{"get":{"deprecated":false,"description":"Download our entire BIN database for direct use on your own systems","operationId":"BINListDownload","parameters":[{"description":"Include ISO 3-letter country codes and ISO 3-letter currency codes in the data. These will be added to columns 10 and 11 respectively","in":"query","name":"include-iso3","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Include 8-digit and higher BIN codes. This option includes all 6-digit BINs and all 8-digit and higher BINs (including some 9, 10 and 11 digit BINs where available)","in":"query","name":"include-8digit","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"default":"","format":"binary","type":"string"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"BIN List Download","tags":["E-commerce"]}},"/bin-lookup":{"get":{"deprecated":false,"description":"Perform a BIN (Bank Identification Number) or IIN (Issuer Identification Number) lookup","operationId":"BINLookup","parameters":[{"description":"The BIN or IIN number. This is the first 6, 8 or 10 digits of a card number, use 8 (or more) digits for the highest level of accuracy","in":"query","name":"bin-number","required":true,"schema":{"type":"string"}},{"description":"Pass in the customers IP address and we will return some extra information about them","in":"query","name":"customer-ip","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BINLookupResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"BIN Lookup","tags":["E-commerce"]}},"/browser-bot":{"post":{"deprecated":false,"description":"Browser bot can extract content, interact with keyboard and mouse events, and execute JavaScript on a website","operationId":"BrowserBot","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"delay":{"default":3,"description":"Delay in seconds to wait before capturing any page data, executing selectors or JavaScript","format":"int32","type":"integer"},"exec":{"description":"Execute JavaScript on the website. This parameter accepts JavaScript as either a string containing JavaScript or for sending multiple separate statements a JSON array or POST array can also be used. If a statement returns any value it will be returned in the 'exec-results' response. You can also use the following specially defined user interaction functions: <br> <br> <div> sleep(seconds); Just wait/sleep for the specified number of seconds. <br>click('selector'); Click on the first element matching the given selector. <br>focus('selector'); Focus on the first element matching the given selector. <br>keys('characters'); Send the specified keyboard characters. Use click() or focus() first to send keys to a specific element. <br>enter(); Send the Enter key. <br>tab(); Send the Tab key. <br> </div>","items":{"type":"string"},"type":"array"},"ignore-certificate-errors":{"default":false,"description":"Ignore any TLS/SSL certificate errors and load the page anyway","type":"boolean"},"selector":{"description":"Extract content from the page DOM using this selector. Commonly known as a CSS selector, you can find a good reference <a href=\"https://www.w3schools.com/cssref/css_selectors.asp\">here</a>","type":"string"},"timeout":{"default":30,"description":"Timeout in seconds. Give up if still trying to load the page after this number of seconds","format":"int32","type":"integer"},"url":{"description":"The URL to load","type":"string"},"user-agent":{"description":"Override the browsers default user-agent string with this one","type":"string"}},"required":["url"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserBotResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Browser Bot","tags":["WWW"]}},"/convert":{"get":{"deprecated":false,"description":"A currency and unit conversion tool","operationId":"Convert","parameters":[{"description":"The value to convert from (e.g. 10.95)","in":"query","name":"from-value","required":true,"schema":{"type":"string"}},{"description":"The type of the value to convert from (e.g. USD)","in":"query","name":"from-type","required":true,"schema":{"type":"string"}},{"description":"The type to convert to (e.g. EUR)","in":"query","name":"to-type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Convert","tags":["E-commerce"]}},"/domain-lookup":{"get":{"deprecated":false,"description":"Retrieve domain name details and detect potentially malicious or dangerous domains","operationId":"DomainLookup","parameters":[{"description":"A domain name, hostname, FQDN, URL, HTML link or email address to lookup","in":"query","name":"host","required":true,"schema":{"type":"string"}},{"description":"For domains that we have never seen before then perform various live checks and realtime reconnaissance. <br>NOTE: this option may add additional non-deterministic delay to the request, if you require consistently fast API response times or just want to check our domain blocklists then you can disable this option","in":"query","name":"live","required":false,"schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainLookupResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Domain Lookup","tags":["Security and Networking"]}},"/email-validate":{"get":{"deprecated":false,"description":"Parse, validate and clean an email address","operationId":"EmailValidate","parameters":[{"description":"An email address","in":"query","name":"email","required":true,"schema":{"type":"string"}},{"description":"Automatically attempt to fix typos in the address","in":"query","name":"fix-typos","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailValidateResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Email Validate","tags":["Data Tools"]}},"/email-verify":{"get":{"deprecated":false,"description":"SMTP based email address verification","operationId":"EmailVerify","parameters":[{"description":"An email address","in":"query","name":"email","required":true,"schema":{"type":"string"}},{"description":"Automatically attempt to fix typos in the address","in":"query","name":"fix-typos","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailVerifyResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Email Verify","tags":["Security and Networking"]}},"/geocode-address":{"get":{"deprecated":false,"description":"Geocode an address, partial address or just the name of a place","operationId":"GeocodeAddress","parameters":[{"description":"The full address, partial address or name of a place to try and locate. Comma separated address components are preferred.","in":"query","name":"address","required":false,"schema":{"type":"string"}},{"description":"The house/building number to locate","in":"query","name":"house-number","required":false,"schema":{"type":"string"}},{"description":"The street/road name to locate","in":"query","name":"street","required":false,"schema":{"type":"string"}},{"description":"The city/town name to locate","in":"query","name":"city","required":false,"schema":{"type":"string"}},{"description":"The county/region name to locate","in":"query","name":"county","required":false,"schema":{"type":"string"}},{"description":"The state name to locate","in":"query","name":"state","required":false,"schema":{"type":"string"}},{"description":"The postal code to locate","in":"query","name":"postal-code","required":false,"schema":{"type":"string"}},{"description":"Limit result to this country (the default is no country bias)","in":"query","name":"country-code","required":false,"schema":{"type":"string"}},{"description":"The language to display results in, available languages are: <ul> <li>de, en, es, fr, it, pt, ru, zh</li> </ul>","in":"query","name":"language-code","required":false,"schema":{"default":"en","type":"string"}},{"description":"If no matches are found for the given address, start performing a recursive fuzzy search until a geolocation is found. This option is recommended for processing user input or implementing auto-complete. We use a combination of approximate string matching and data cleansing to find possible location matches","in":"query","name":"fuzzy-search","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeocodeAddressResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Geocode Address","tags":["Geolocation"]}},"/geocode-reverse":{"get":{"deprecated":false,"description":"Convert a geographic coordinate (latitude and longitude) into a real world address","operationId":"GeocodeReverse","parameters":[{"description":"The location latitude in decimal degrees format","in":"query","name":"latitude","required":true,"schema":{"type":"string"}},{"description":"The location longitude in decimal degrees format","in":"query","name":"longitude","required":true,"schema":{"type":"string"}},{"description":"The language to display results in, available languages are: <ul> <li>de, en, es, fr, it, pt, ru</li> </ul>","in":"query","name":"language-code","required":false,"schema":{"default":"en","type":"string"}},{"description":"The zoom level to respond with: <br> <ul> <li>address - the most precise address available</li> <li>street - the street level</li> <li>city - the city level</li> <li>state - the state level</li> <li>country - the country level</li> </ul>","in":"query","name":"zoom","required":false,"schema":{"default":"address","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeocodeReverseResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Geocode Reverse","tags":["Geolocation"]}},"/hlr-lookup":{"get":{"deprecated":false,"description":"Connect to the global mobile cellular network and retrieve the status of a mobile device","operationId":"HLRLookup","parameters":[{"description":"A phone number","in":"query","name":"number","required":true,"schema":{"type":"string"}},{"description":"ISO 2-letter country code, assume numbers are based in this country. <br>If not set numbers are assumed to be in international format (with or without the leading + sign)","in":"query","name":"country-code","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HLRLookupResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"HLR Lookup","tags":["Telephony"]}},"/host-reputation":{"get":{"deprecated":false,"description":"Check the reputation of an IP address, domain name or URL against a comprehensive list of blacklists and blocklists","operationId":"HostReputation","parameters":[{"description":"An IP address, domain name, FQDN or URL. <br>If you supply a domain/URL it will be checked against the URI DNSBL lists","in":"query","name":"host","required":true,"schema":{"type":"string"}},{"description":"Only check lists with this rating or better","in":"query","name":"list-rating","required":false,"schema":{"default":3,"format":"int32","type":"integer"}},{"description":"Only check these DNSBL zones/hosts. Multiple zones can be supplied as comma-separated values","in":"query","name":"zones","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostReputationResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Host Reputation","tags":["Security and Networking"]}},"/html-clean":{"post":{"deprecated":false,"description":"Clean and sanitize untrusted HTML","operationId":"HTMLClean","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"content":{"description":"The HTML content. This can be either a URL to load from, a file upload (multipart/form-data) or an HTML content string","type":"string"},"output-type":{"description":"The level of sanitization, possible values are: <br><b>plain-text</b>: reduce the content to plain text only (no HTML tags at all) <br><b>simple-text</b>: allow only very basic text formatting tags like b, em, i, strong, u <br><b>basic-html</b>: allow advanced text formatting and hyper links <br><b>basic-html-with-images</b>: same as basic html but also allows image tags <br><b>advanced-html</b>: same as basic html with images but also allows many more common HTML tags like table, ul, dl, pre <br>","type":"string"}},"required":["content","output-type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"default":"","format":"binary","type":"string"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"HTML Clean","tags":["WWW"]}},"/html-render":{"post":{"deprecated":false,"description":"Render HTML content to PDF, JPG or PNG","operationId":"HTMLRender","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"content":{"description":"The HTML content. This can be either a URL to load from, a file upload (multipart/form-data) or an HTML content string","type":"string"},"css":{"description":"Inject custom CSS into the HTML. e.g. 'body { background-color: red;}'","type":"string"},"delay":{"default":0,"description":"Number of seconds to wait before rendering the page (can be useful for pages with animations etc)","format":"int32","type":"integer"},"footer":{"description":"The footer HTML to insert into each page. The following dynamic tags are supported: {date}, {title}, {url}, {pageNumber}, {totalPages}","type":"string"},"format":{"default":"PDF","description":"Which format to output, available options are: PDF, PNG, JPG","type":"string"},"grayscale":{"default":false,"description":"Render the final document in grayscale","type":"boolean"},"header":{"description":"The header HTML to insert into each page. The following dynamic tags are supported: {date}, {title}, {url}, {pageNumber}, {totalPages}","type":"string"},"ignore-certificate-errors":{"default":false,"description":"Ignore any TLS/SSL certificate errors","type":"boolean"},"image-height":{"description":"If rendering to an image format (PNG or JPG) use this image height (in pixels). The default is automatic which dynamically sets the image height based on the content","format":"int32","type":"integer"},"image-width":{"default":1024,"description":"If rendering to an image format (PNG or JPG) use this image width (in pixels)","format":"int32","type":"integer"},"landscape":{"default":false,"description":"Set the document to landscape orientation","type":"boolean"},"margin":{"default":0,"description":"The document margin (in mm)","format":"double","type":"number"},"margin-bottom":{"default":0,"description":"The document bottom margin (in mm)","format":"double","type":"number"},"margin-left":{"default":0,"description":"The document left margin (in mm)","format":"double","type":"number"},"margin-right":{"default":0,"description":"The document right margin (in mm)","format":"double","type":"number"},"margin-top":{"default":0,"description":"The document top margin (in mm)","format":"double","type":"number"},"page-height":{"description":"Set the PDF page height explicitly (in mm)","format":"double","type":"number"},"page-size":{"default":"A4","description":"Set the document page size, can be one of: A0 - A9, B0 - B10, Comm10E, DLE or Letter","type":"string"},"page-width":{"description":"Set the PDF page width explicitly (in mm)","format":"double","type":"number"},"timeout":{"default":300,"description":"Timeout in seconds. Give up if still trying to load the HTML content after this number of seconds","format":"int32","type":"integer"},"title":{"description":"The document title","type":"string"},"zoom":{"default":1,"description":"Set the zoom factor when rendering the page (2.0 for double size, 0.5 for half size)","format":"double","type":"number"}},"required":["content"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"default":"","format":"binary","type":"string"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"HTML Render","tags":["Imaging"]}},"/image-resize":{"post":{"deprecated":false,"description":"Resize an image and output as either JPEG or PNG","operationId":"ImageResize","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"bg-color":{"default":"transparent","description":"The image background color in hexadecimal notation (e.g. #0000ff). For PNG output the special value of 'transparent' can also be used. For JPG output the default is black (#000000)","type":"string"},"format":{"default":"png","description":"The output image format, can be either png or jpg","type":"string"},"height":{"description":"The height to resize to (in px). If you don't set this field then the height will be automatic based on the requested width and image aspect ratio","format":"int32","type":"integer"},"image-url":{"description":"The URL or Base64 encoded Data URL for the source image. You can also upload an image file directly using multipart/form-data","type":"string"},"resize-mode":{"default":"scale","description":"The resize mode to use, we support 3 main resizing modes: <ul> <li><b>scale</b><br>Resize to within the width and height specified while preserving aspect ratio. In this mode the width or height will be automatically adjusted to fit the aspect ratio</li> <li><b>pad</b><br>Resize to exactly the width and height specified while preserving aspect ratio and pad any space left over. Any padded space will be filled in with the 'bg-color' value</li> <li><b>crop</b><br>Resize to exactly the width and height specified while preserving aspect ratio and crop any space which fall outside the area. The cropping window is centered on the original image</li> </ul>","type":"string"},"width":{"description":"The width to resize to (in px)","format":"int32","type":"integer"}},"required":["image-url","width"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"default":"","format":"binary","type":"string"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Image Resize","tags":["Imaging"]}},"/image-watermark":{"post":{"deprecated":false,"description":"Watermark one image with another image","operationId":"ImageWatermark","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"bg-color":{"default":"transparent","description":"The image background color in hexadecimal notation (e.g. #0000ff). For PNG output the special value of 'transparent' can also be used. For JPG output the default is black (#000000)","type":"string"},"format":{"default":"png","description":"The output image format, can be either png or jpg","type":"string"},"height":{"description":"If set resize the resulting image to this height (in px)","format":"int32","type":"integer"},"image-url":{"description":"The URL or Base64 encoded Data URL for the source image. You can also upload an image file directly using multipart/form-data","type":"string"},"opacity":{"default":50,"description":"The opacity of the watermark (0 to 100)","format":"int32","type":"integer"},"position":{"default":"center","description":"The position of the watermark image, possible values are: <br>center, top-left, top-center, top-right, bottom-left, bottom-center, bottom-right","type":"string"},"resize-mode":{"default":"scale","description":"The resize mode to use, we support 3 main resizing modes: <ul> <li><b>scale</b><br>Resize to within the width and height specified while preserving aspect ratio. In this mode the width or height will be automatically adjusted to fit the aspect ratio</li> <li><b>pad</b><br>Resize to exactly the width and height specified while preserving aspect ratio and pad any space left over. Any padded space will be filled in with the 'bg-color' value</li> <li><b>crop</b><br>Resize to exactly the width and height specified while preserving aspect ratio and crop any space which fall outside the area. The cropping window is centered on the original image</li> </ul>","type":"string"},"watermark-url":{"description":"The URL or Base64 encoded Data URL for the watermark image. You can also upload an image file directly using multipart/form-data","type":"string"},"width":{"description":"If set resize the resulting image to this width (in px)","format":"int32","type":"integer"}},"required":["image-url","watermark-url"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"default":"","format":"binary","type":"string"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Image Watermark","tags":["Imaging"]}},"/ip-blocklist":{"get":{"deprecated":false,"description":"The IP Blocklist API will detect potentially malicious or dangerous IP addresses","operationId":"IPBlocklist","parameters":[{"description":"An IPv4 or IPv6 address. Accepts standard IP notation (with or without port number), CIDR notation and IPv6 compressed notation. If multiple IPs are passed using comma-separated values the first non-bogon address on the list will be checked","in":"query","name":"ip","required":true,"schema":{"type":"string"}},{"description":"Include public VPN provider IP addresses. <br><b>NOTE</b>: For more advanced VPN detection including the ability to identify private and stealth VPNs use the <a href=\"https://www.neutrinoapi.com/api/ip-probe/\">IP Probe API</a>","in":"query","name":"vpn-lookup","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPBlocklistResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"IP Blocklist","tags":["Security and Networking"]}},"/ip-blocklist-download":{"get":{"deprecated":false,"description":"This API is a direct feed to our IP blocklist data","operationId":"IPBlocklistDownload","parameters":[{"description":"The data format. Can be either CSV or TXT","in":"query","name":"format","required":false,"schema":{"default":"csv","type":"string"}},{"description":"Include public VPN provider addresses, this option is only available for Tier 3 or higher accounts. Adds any IPs which are solely listed as VPN providers, IPs that are listed on multiple sensors will still be included without enabling this option. <br><b>WARNING</b>: This adds at least an additional 8 million IP addresses to the download if not using CIDR notation","in":"query","name":"include-vpn","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Output IPs using CIDR notation. This option should be preferred but is off by default for backwards compatibility","in":"query","name":"cidr","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Output the IPv6 version of the blocklist, the default is to output IPv4 only. Note that this option enables CIDR notation too as this is the only notation currently supported for IPv6","in":"query","name":"ip6","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"default":"","format":"binary","type":"string"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"IP Blocklist Download","tags":["Security and Networking"]}},"/ip-info":{"get":{"deprecated":false,"description":"Get location information about an IP address and do reverse DNS (PTR) lookups","operationId":"IPInfo","parameters":[{"description":"IPv4 or IPv6 address","in":"query","name":"ip","required":true,"schema":{"type":"string"}},{"description":"Do a reverse DNS (PTR) lookup. This option can add extra delay to the request so only use it if you need it","in":"query","name":"reverse-lookup","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPInfoResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"IP Info","tags":["Geolocation"]}},"/ip-probe":{"get":{"deprecated":false,"description":"Execute a realtime network probe against an IPv4 or IPv6 address","operationId":"IPProbe","parameters":[{"description":"IPv4 or IPv6 address","in":"query","name":"ip","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPProbeResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"IP Probe","tags":["Security and Networking"]}},"/phone-playback":{"post":{"deprecated":false,"description":"Make an automated call to any valid phone number and playback an audio message","operationId":"PhonePlayback","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"audio-url":{"description":"A URL to a valid audio file. Accepted audio formats are: <ul> <li>MP3</li> <li>WAV</li> <li>OGG</li> </ul>You can use the following MP3 URL for testing: <br>https://www.neutrinoapi.com/test-files/test1.mp3","type":"string"},"limit":{"default":3,"description":"Limit the total number of calls allowed to the supplied phone number, if the limit is reached within the TTL then error code 14 will be returned","format":"int32","type":"integer"},"limit-ttl":{"default":1,"description":"Set the TTL in number of days that the 'limit' option will remember a phone number (the default is 1 day and the maximum is 365 days)","format":"int32","type":"integer"},"number":{"description":"The phone number to call. Must be in valid international format","type":"string"}},"required":["number","audio-url"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhonePlaybackResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Phone Playback","tags":["Telephony"]}},"/phone-validate":{"get":{"deprecated":false,"description":"Parse, validate and get location information about a phone number","operationId":"PhoneValidate","parameters":[{"description":"A phone number. This can be in international format (E.164) or local format. If passing local format you must also set either the 'country-code' OR 'ip' options as well","in":"query","name":"number","required":true,"schema":{"type":"string"}},{"description":"ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)","in":"query","name":"country-code","required":false,"schema":{"type":"string"}},{"description":"Pass in a users IP address and we will assume numbers are based in the country of the IP address","in":"query","name":"ip","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneValidateResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Phone Validate","tags":["Data Tools"]}},"/phone-verify":{"post":{"deprecated":false,"description":"Make an automated call to any valid phone number and playback a unique security code","operationId":"PhoneVerify","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"code-length":{"default":6,"description":"The number of digits to use in the security code (between 4 and 12)","format":"int32","type":"integer"},"country-code":{"description":"ISO 2-letter country code, assume numbers are based in this country. <br>If not set numbers are assumed to be in international format (with or without the leading + sign)","type":"string"},"language-code":{"default":"en","description":"The language to playback the verification code in, available languages are: <ul> <li>de - German</li> <li>en - English</li> <li>es - Spanish</li> <li>fr - French</li> <li>it - Italian</li> <li>pt - Portuguese</li> <li>ru - Russian</li> </ul>","type":"string"},"limit":{"default":3,"description":"Limit the total number of calls allowed to the supplied phone number, if the limit is reached within the TTL then error code 14 will be returned","format":"int32","type":"integer"},"limit-ttl":{"default":1,"description":"Set the TTL in number of days that the 'limit' option will remember a phone number (the default is 1 day and the maximum is 365 days)","format":"int32","type":"integer"},"number":{"description":"The phone number to send the verification code to","type":"string"},"playback-delay":{"default":800,"description":"The delay in milliseconds between the playback of each security code","format":"int32","type":"integer"},"security-code":{"description":"Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code","format":"int32","type":"integer"}},"required":["number"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneVerifyResponse"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"Phone Verify","tags":["Telephony"]}},"/qr-code":{"post":{"deprecated":false,"description":"Generate a QR code as a PNG image","operationId":"QRCode","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"bg-color":{"default":"#ffffff","description":"The QR code background color","type":"string"},"content":{"description":"The content to encode into the QR code (e.g. a URL or a phone number)","type":"string"},"fg-color":{"default":"#000000","description":"The QR code foreground color","type":"string"},"height":{"default":256,"description":"The height of the QR code (in px)","format":"int32","type":"integer"},"width":{"default":256,"description":"The width of the QR code (in px)","format":"int32","type":"integer"}},"required":["content"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"default":"","format":"binary","type":"string"}}},"description":"","headers":{}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"Your API request has been rejected. Check error code for details"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"You have failed to authenticate"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused a fatal exception"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}},"description":"We messed up, sorry! Your request has caused an error"}},"summary":"QR Code","tags":["Imaging"]}},"/sms-verify":{"post":{"deprecated":false,"description":"Send a unique security code to any mobile device via SMS","operationId":"SMSVerify","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"code-length":{"default":5,"description":"The number of digits to use in the security code (must be between 4 and 12)","format":"int32","type":"integer"},"country-code":{"description":"ISO 2-letter country code, assume numbers are based in this country. <br>If not set numbers are assumed to be in international format (with or without the leading + sign)","type":"string"},"language-code":{"default":"en","description":"The language to send the verification code in, available languages are: <ul> <li>de - German</li> <li>en - English</li> <li>es - Spanish</li> <li>fr - French</li> <li>it - Italian</li> <li>pt - Portuguese</li> <li>ru - Russian</li> </ul>","type":"string"},"limit":{"default":10,"description":"Limit the total number of SMS allowed to the supplied phone number, if the limit is reached within the TTL then error code 14 will be returned","format":"int32","type":"integer"},"limit-ttl":{"default":1,"description":"Set the TTL in number of days that the 'limit' option will remember a phone number (the default is 1 day and the maximum is 365 days)","format":"int32","type":"integer"},"number":{"description":"The phone number to send a verification code to","type":"string"},"security-code":{"description":"Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code","format":"int32","type":"integer"}},"required":["number"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SMSVerifyResponse"}}},"description":"","headers":{}},"400":{"content":{"application/jso