ipfinder v1.0.0 Ipfinder View Source
Documentation for Ipfinder.
Link to this section Summary
Types
List of options to all request functions.
Result returned from request!/3
, get!/2
, post!/2
, put!/2
, etc.
Functions
Get details for an Your IP address.
call to server
A shortcut for request(:delete, url, options)
.
A shortcut for request!(:delete, url, options)
.
A shortcut for request(:get, url, options)
.
A shortcut for request!(:get, url, options)
.
Get details for an IP address.
Get details for an AS number.
Get Domain IP
Get list Domain By ASN, Country,Ranges
Get Domain History IP
Get Firewall data
Get details for an Organization name.
Get details for an API Token .
A shortcut for request(:head, url, options)
.
A shortcut for request!(:head, url, options)
.
A shortcut for request(:options, url, options)
.
A shortcut for request!(:options, url, options)
.
A shortcut for request(:patch, url, options)
.
A shortcut for request!(:patch, url, options)
.
A shortcut for request(:post, url, options)
.
A shortcut for request!(:post, url, options)
.
A shortcut for request(:put, url, options)
.
A shortcut for request!(:put, url, options)
.
Sends an HTTP request.
Like request/3
, but raises HTTPotion.HTTPError
if failed.
Starts a linked worker process for use with the direct
option.
Starts a worker process for use with the direct
option.
Ensures that HTTPotion and its dependencies are started.
Stops a worker process started with spawn_worker_process/2
or spawn_link_worker_process/2
.
Link to this section Types
http_opts()
View Sourcehttp_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 bodyheaders
- HTTP headers (e.g.["Accept": "application/json"]
)query
- URL query string (e.g.%{page: 1}
)timeout
- timeout in millisecondsbasic_auth
- basic auth credentials (e.g.{"user", "password"}
)stream_to
- if you want to make an async request, reference to the processdirect
- if you want to use ibrowse's direct feature, reference tothe 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 ibrowseauto_sni
- if true and the URL is https, configures theserver_name_indication
ibrowse/ssl optionto be the host part of the requestedURL
follow_redirects
- if true and a response is a redirect, re-requests withheader[:Location]
http_result()
View Sourcehttp_result() :: HTTPotion.Response.t() | %HTTPotion.AsyncResponse{id: term()} | %HTTPotion.ErrorResponse{message: term()}
http_result_bang()
View Sourcehttp_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
Get details for an Your IP address.
Parameters
this
- Ipfinder
Examples
{:ok, auth} = Ipfinder.authentication(Ipfinder)
call to server
Parameters
this
- Ipfinderpath
- specific path of asn, IP address, ranges, Firewall,Token statusformat
- available formatjson
jsonp
php
xml
and Firewall format
delete(url, options \\ [])
View Sourcedelete(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:delete, url, options)
.
delete!(url, options \\ [])
View Sourcedelete!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:delete, url, options)
.
get(url, options \\ [])
View Sourceget(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:get, url, options)
.
get!(url, options \\ [])
View Sourceget!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:get, url, options)
.
Get details for an IP address.
Parameters
{:ok, ip} = Ipfinder.getAddressInfo(Ipfinder,"1.0.0.0")
Get details for an AS number.
Parameters
{:ok, asn} = Ipfinder.getAsn(Ipfinder,"as1")
Get Domain IP
Parameters
{:ok, range} = Ipfinder.getDomain(Ipfinder,"google.com")
Get list Domain By ASN, Country,Ranges
Parameters
{:ok, range} = Ipfinder.getDomainHistory(Ipfinder,"DZ")
Get Domain History IP
Parameters
{:ok, range} = Ipfinder.getDomainHistory(Ipfinder,"google.com")
Get Firewall data
Parameters
{:ok, range} = Ipfinder.getFirewall(Ipfinder,"DZ",'nginx_deny')
Get details for an Organization name.
Parameters
{:ok, range} = Ipfinder.getRanges(Ipfinder,"Telecom Algeria")
Get details for an API Token .
## Examples
{:ok, status} = Ipfinder.getStatus(Ipfinder)
head(url, options \\ [])
View Sourcehead(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:head, url, options)
.
head!(url, options \\ [])
View Sourcehead!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:head, url, options)
.
Constructor
Parameters
token
- add your tokenbaseUrl
- add proxy pass
options(url, options \\ [])
View Sourceoptions(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:options, url, options)
.
options!(url, options \\ [])
View Sourceoptions!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:options, url, options)
.
patch(url, options \\ [])
View Sourcepatch(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:patch, url, options)
.
patch!(url, options \\ [])
View Sourcepatch!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:patch, url, options)
.
post(url, options \\ [])
View Sourcepost(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:post, url, options)
.
post!(url, options \\ [])
View Sourcepost!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:post, url, options)
.
put(url, options \\ [])
View Sourceput(String.Chars.t(), http_opts()) :: http_result()
A shortcut for request(:put, url, options)
.
put!(url, options \\ [])
View Sourceput!(String.Chars.t(), http_opts()) :: http_result_bang()
A shortcut for request!(:put, url, options)
.
request(method, url, options \\ [])
View Sourcerequest(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, options \\ [])
View Sourcerequest!(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 \\ [])
View SourceStarts a linked worker process for use with the direct
option.
Starts a worker process for use with the direct
option.
Ensures that HTTPotion and its dependencies are started.
Stops a worker process started with spawn_worker_process/2
or spawn_link_worker_process/2
.