ipfinder v1.0.1 Ipfinder View Source

IPFinder elixir Client Library

The official elixir client library for the IPFinder.io get details for :

IP address details (city, region, country, postal code, latitude and more ..)
ASN details (Organization name, registry,domain,comany_type, and more .. )
Firewall by supported formats details (apache_allow, nginx_deny, CIDR , and more ..)
IP Address Ranges by the Organization name details (list_asn, list_prefixes , and more ..)
service status details (queriesPerDay, queriesLeft, key_type, key_info)
Get Domain IP (asn, organization,country_code ....)
Get Domain IP history (total_ip, list_ip,organization,asn ....)
Get list Domain By ASN, Country,Ranges (select_by , total_domain , list_domain ....)
GitHub
ipfinder

Documentation for Ipfinder.

Link to this section Summary

Types

http_opts()

List of options to all request functions.

http_result()

Result returned from request/3, get/2, post/2, put/2, etc.

http_result_bang()

Result returned from request!/3, get!/2, post!/2, put!/2, etc.

Functions

authentication(this)

Get details for an Your IP address.

call(this, path, format \\ "json")

call to server

default_api_token()

default_base_url()

delete(url, options \\ [])

A shortcut for request(:delete, url, options).

delete!(url, options \\ [])

A shortcut for request!(:delete, url, options).

domain_by_path()

domain_h_path()

domain_path()

firewall_path()

format()

get(url, options \\ [])

A shortcut for request(:get, url, options).

get!(url, options \\ [])

A shortcut for request!(:get, url, options).

getAddressInfo(this, path)

Get details for an IP address.

getAsn(this, path)

Get details for an AS number.

getDomain(this, path)

Get Domain IP

getDomainBy(this, by)

Get list Domain By ASN, Country,Ranges

getDomainHistory(this, path)

Get Domain History IP

getFirewall(this, path, formats)

Get Firewall data

getRanges(this, path)

Get details for an Organization name.

getStatus(this)

Get details for an API Token .

handle_response(response)

head(url, options \\ [])

A shortcut for request(:head, url, options).

head!(url, options \\ [])

A shortcut for request!(:head, url, options).

is_redirect(response)

new(token \\ "free", baseUrl \\ "https://api.ipfinder.io/v1/")

Constructor

options(url, options \\ [])

A shortcut for request(:options, url, options).

options!(url, options \\ [])

A shortcut for request!(:options, url, options).

patch(url, options \\ [])

A shortcut for request(:patch, url, options).

patch!(url, options \\ [])

A shortcut for request!(:patch, url, options).

post(url, options \\ [])

A shortcut for request(:post, url, options).

post!(url, options \\ [])

A shortcut for request!(:post, url, options).

process_options(options)

process_request_body(body)

process_request_headers(headers)

process_request_headers(headers, body)

process_request_headers(headers, body, options)

process_response_body(body)

process_response_body(headers, body)

process_response_chunk(body)

process_response_headers(headers)

process_response_location(response)

process_status_code(status_code)

process_url(url)

process_url(url, options)

put(url, options \\ [])

A shortcut for request(:put, url, options).

put!(url, options \\ [])

A shortcut for request!(:put, url, options).

ranges_path()

redirect_method(response, method)

request(method, url, options \\ [])

Sends an HTTP request.

request(method, url, body, headers, options) deprecated

request!(method, url, options \\ [])

Like request/3, but raises HTTPotion.HTTPError if failed.

request_direct(conn_pid, method, url, body \\ "", headers \\ [], options \\ []) deprecated

response_ok(response)

spawn_link_worker_process(url, options \\ [])

Starts a linked worker process for use with the direct option.

spawn_worker_process(url, options \\ [])

Starts a worker process for use with the direct option.

start()

Ensures that HTTPotion and its dependencies are started.

status_path()

stop_worker_process(pid)

Stops a worker process started with spawn_worker_process/2 or spawn_link_worker_process/2.

transformer(target, method, url, options)

Link to this section Types

http_opts()

http_opts() :: [
  body: binary() | charlist(),
  headers: [{atom() | String.Chars.t(), String.Chars.t()}],
  query: %{optional(String.Chars.t()) => String.Chars.t()},
  timeout: timeout(),
  basic_auth: {List.Chars.t(), List.Chars.t()},
  stream_to: pid() | port() | atom() | {atom(), node()},
  direct: pid() | port() | atom() | {atom(), node()},
  ibrowse: keyword(),
  auto_sni: boolean(),
  follow_redirects: boolean()
]

List of options to all request functions.

body - request body
headers - HTTP headers (e.g. ["Accept": "application/json"])
query - URL query string (e.g. %{page: 1})
timeout - timeout in milliseconds
basic_auth - basic auth credentials (e.g. {"user", "password"})
stream_to - if you want to make an async request, reference to the process

direct - if you want to use ibrowse's direct feature, reference to

       the worker spawned by [`spawn_worker_process/2`](#spawn_worker_process/2) or [`spawn_link_worker_process/2`](#spawn_link_worker_process/2)

ibrowse - options for ibrowse
auto_sni - if true and the URL is https, configures the server_name_indication ibrowse/ssl option
```
         to be the host part of the requestedURL
```
follow_redirects - if true and a response is a redirect, re-requests with header[:Location]

http_result()

http_result() ::
  HTTPotion.Response.t()
  | %HTTPotion.AsyncResponse{id: term()}
  | %HTTPotion.ErrorResponse{message: term()}

Result returned from request/3, get/2, post/2, put/2, etc.

http_result_bang()

http_result_bang() ::
  HTTPotion.Response.t() | %HTTPotion.AsyncResponse{id: term()}

Result returned from request!/3, get!/2, post!/2, put!/2, etc.

Link to this section Functions

authentication(this)

Get details for an Your IP address.

Parameters

this - Ipfinder

Examples

{:ok, auth} = Ipfinder.authentication(Ipfinder)

call(this, path, format \\ "json")

call to server

Parameters

this - Ipfinder
path - specific path of asn, IP address, ranges, Firewall,Token status
format- available format json jsonp php xmland Firewall format

default_api_token()

default_base_url()

delete(url, options \\ [])

delete(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:delete, url, options).

delete!(url, options \\ [])

delete!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:delete, url, options).

domain_by_path()

domain_h_path()

domain_path()

firewall_path()

format()

get(url, options \\ [])

get(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:get, url, options).

get!(url, options \\ [])

get!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:get, url, options).

getAddressInfo(this, path)

Get details for an IP address.

Parameters

this - Ipfinder
path - IP address.

Examples

{:ok, ip} = Ipfinder.getAddressInfo(Ipfinder,"1.0.0.0")

getAsn(this, path)

Get details for an AS number.

Parameters

this - Ipfinder
path - AS number.

Examples

{:ok, asn} = Ipfinder.getAsn(Ipfinder,"as1")

getDomain(this, path)

Get Domain IP

Parameters

this - Ipfinder
path - The API supports passing in a single website name domain name

Examples

{:ok, range} = Ipfinder.getDomain(Ipfinder,"google.com")

getDomainBy(this, by)

Get list Domain By ASN, Country,Ranges

Parameters

this - Ipfinder
by - The API supports passing in a single ASN,Country,Ranges

Examples

{:ok, range} = Ipfinder.getDomainHistory(Ipfinder,"DZ")

getDomainHistory(this, path)

Get Domain History IP

Parameters

this - Ipfinder
path - The API supports passing in a single website name domain name

Examples

{:ok, range} = Ipfinder.getDomainHistory(Ipfinder,"google.com")

getFirewall(this, path, formats)

Get Firewall data

Parameters

this - Ipfinder
path - AS number, alpha-2 country only.
formats - list formats supported

Examples

{:ok, range} = Ipfinder.getFirewall(Ipfinder,"DZ",'nginx_deny')

getRanges(this, path)

Get details for an Organization name.

Parameters

this - Ipfinder
path - Organization name.

Examples

{:ok, range} = Ipfinder.getRanges(Ipfinder,"Telecom Algeria")

getStatus(this)

Get details for an API Token .

## Examples

{:ok, status} = Ipfinder.getStatus(Ipfinder)

handle_response(response)

head(url, options \\ [])

head(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:head, url, options).

head!(url, options \\ [])

head!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:head, url, options).

is_redirect(response)

new(token \\ "free", baseUrl \\ "https://api.ipfinder.io/v1/")

Constructor

Parameters

token - add your token
baseUrl - add proxy pass

options(url, options \\ [])

options(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:options, url, options).

options!(url, options \\ [])

options!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:options, url, options).

patch(url, options \\ [])

patch(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:patch, url, options).

patch!(url, options \\ [])

patch!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:patch, url, options).

post(url, options \\ [])

post(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:post, url, options).

post!(url, options \\ [])

post!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:post, url, options).

process_options(options)

process_request_body(body)

process_request_headers(headers)

process_request_headers(headers, body)

process_request_headers(headers, body, options)

process_response_body(body)

process_response_body(headers, body)

process_response_chunk(body)

process_response_headers(headers)

process_response_location(response)

process_status_code(status_code)

process_url(url)

process_url(url, options)

put(url, options \\ [])

put(String.Chars.t(), http_opts()) :: http_result()

A shortcut for request(:put, url, options).

put!(url, options \\ [])

put!(String.Chars.t(), http_opts()) :: http_result_bang()

A shortcut for request!(:put, url, options).

ranges_path()

redirect_method(response, method)

request(method, url, options \\ [])

request(atom(), String.Chars.t(), http_opts()) :: http_result()

Sends an HTTP request.

See the type documentation of http_opts for a description of options.

request(method, url, body, headers, options)

This function is deprecated. Use request/3 instead.

request!(method, url, options \\ [])

request!(atom(), String.Chars.t(), http_opts()) :: http_result_bang()

Like request/3, but raises HTTPotion.HTTPError if failed.

request_direct(conn_pid, method, url, body \\ "", headers \\ [], options \\ [])

This function is deprecated. Use request/3 with 'direct' option instead.

response_ok(response)

spawn_link_worker_process(url, options \\ [])

Starts a linked worker process for use with the direct option.

spawn_worker_process(url, options \\ [])

Starts a worker process for use with the direct option.

start()

Ensures that HTTPotion and its dependencies are started.

status_path()

stop_worker_process(pid)

Stops a worker process started with spawn_worker_process/2 or spawn_link_worker_process/2.

transformer(target, method, url, options)