@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Neutrino API
@base https://neutrinoapi.net/
@version 3.7.2
@auth ApiKey user-id in header | ApiKey api-key in header
@endpoints 28
@hint download_for_search
@toc html-render(1), image-watermark(1), qr-code(1), image-resize(1), sms-verify(1), phone-playback(1), hlr-lookup(1), verify-security-code(1), phone-verify(1), email-validate(1), bad-word-filter(1), ua-lookup(1), phone-validate(1), ip-blocklist-download(1), ip-probe(1), host-reputation(1), email-verify(1), domain-lookup(1), ip-blocklist(1), ip-info(1), geocode-reverse(1), geocode-address(1), bin-list-download(1), convert(1), bin-lookup(1), html-clean(1), url-info(1), browser-bot(1)

@group html-render
@endpoint POST /html-render
@required {content: any}
@optional {format: any, page-size: any, title: any, margin: any, margin-left: any, margin-right: any, margin-top: any, margin-bottom: any, landscape: any, zoom: any, grayscale: any, css: any, image-width: any, image-height: any, delay: any, page-width: any, page-height: any, timeout: any, ignore-certificate-errors: any, header: any, footer: any, bg-color: any, exec: any, user-agent: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group image-watermark
@endpoint POST /image-watermark
@required {image-url: any, watermark-url: any}
@optional {opacity: any, format: any, position: any, width: any, height: any, resize-mode: any, bg-color: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group qr-code
@endpoint POST /qr-code
@required {content: any}
@optional {width: any, height: any, fg-color: any, bg-color: any, code-format: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group image-resize
@endpoint POST /image-resize
@required {image-url: any, width: any}
@optional {height: any, format: any, resize-mode: any, bg-color: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group sms-verify
@endpoint POST /sms-verify
@required {number: any}
@optional {code-length: any, security-code: any, country-code: any, language-code: any, limit: any, limit-ttl: any, brand-name: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group phone-playback
@endpoint POST /phone-playback
@required {number: any, audio-url: any}
@optional {limit: any, limit-ttl: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group hlr-lookup
@endpoint GET /hlr-lookup
@required {number: any}
@optional {country-code: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group verify-security-code
@endpoint GET /verify-security-code
@required {security-code: any}
@optional {limit-by: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group phone-verify
@endpoint POST /phone-verify
@required {number: any}
@optional {code-length: any, security-code: any, playback-delay: any, country-code: any, language-code: any, limit: any, limit-ttl: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group email-validate
@endpoint GET /email-validate
@required {email: any}
@optional {fix-typos: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group bad-word-filter
@endpoint POST /bad-word-filter
@required {content: any}
@optional {censor-character: any, catalog: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group ua-lookup
@endpoint GET /ua-lookup
@required {ua: any}
@optional {ua-version: any, ua-platform: any, ua-platform-version: any, ua-mobile: any, device-model: any, device-brand: any, ua-arch: any, ua-bitness: any, ua-form-factors: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group phone-validate
@endpoint GET /phone-validate
@required {number: any}
@optional {country-code: any, ip: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group ip-blocklist-download
@endpoint GET /ip-blocklist-download
@optional {format: any, cidr: any, ip6: any, category: any, output-encoding: any, checksum: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group ip-probe
@endpoint GET /ip-probe
@required {ip: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group host-reputation
@endpoint GET /host-reputation
@required {host: any}
@optional {list-rating: any, zones: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group email-verify
@endpoint GET /email-verify
@required {email: any}
@optional {fix-typos: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group domain-lookup
@endpoint GET /domain-lookup
@required {host: any}
@optional {live: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group ip-blocklist
@endpoint GET /ip-blocklist
@required {ip: any}
@optional {vpn-lookup: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group ip-info
@endpoint GET /ip-info
@required {ip: any}
@optional {reverse-lookup: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group geocode-reverse
@endpoint GET /geocode-reverse
@optional {latitude: any, longitude: any, language-code: any, zoom: any, geohash: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group geocode-address
@endpoint GET /geocode-address
@optional {address: any, house-number: any, street: any, city: any, county: any, state: any, postal-code: any, country-code: any, language-code: any, fuzzy-search: any, country-codes: any, auto-complete: any, limit: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group bin-list-download
@endpoint GET /bin-list-download
@optional {include-iso3: any, include-8digit: any, include-all: any, output-encoding: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group convert
@endpoint GET /convert
@required {from-value: any, from-type: any, to-type: any}
@optional {historical-date: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group bin-lookup
@endpoint GET /bin-lookup
@required {bin-number: any}
@optional {customer-ip: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group html-clean
@endpoint POST /html-clean
@required {content: any, output-type: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group url-info
@endpoint GET /url-info
@required {url: any}
@optional {fetch-content: any, ignore-certificate-errors: any, timeout: any, retry: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@group browser-bot
@endpoint POST /browser-bot
@required {url: any}
@optional {timeout: any, delay: any, selector: any, exec: any, user-agent: any, ignore-certificate-errors: any}
@returns(200)
@errors {400, 403, 500}

@endgroup

@end