Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Async client for the ip-api.io API.

let client = ip_api_io::Client::with_api_key("YOUR_API_KEY");
let info = client.lookup_ip("8.8.8.8").await?;
println!("{:?}", info.location.country);

Implementations§

Source§

impl Client

Source

pub fn new() -> Self

Client without an API key (the live API rejects keyless requests — prefer Client::with_api_key).

Source

pub fn with_api_key(key: impl Into<String>) -> Self

Client authenticated with an API key.

Source

pub fn builder() -> ClientBuilder

Source

pub async fn lookup(&self) -> Result<IpInfo, Error>

Geolocation + threat intelligence for the caller’s IP.

Source

pub async fn lookup_ip(&self, ip: &str) -> Result<IpInfo, Error>

Geolocation + threat intelligence for a specific IP.

Source

pub async fn lookup_batch( &self, ips: &[&str], ) -> Result<BatchIpLookupResponse, Error>

Look up to 100 IP addresses in a single request.

Source

pub async fn ip_reputation(&self, ip: &str) -> Result<Value, Error>

IP reputation check (untyped map — shape may evolve).

Source

pub async fn tor_check(&self, ip: &str) -> Result<TorDetection, Error>

Whether an IP is a Tor exit node.

Source

pub async fn asn(&self, ip: &str) -> Result<AsnLookup, Error>

Autonomous system lookup for an IP.

Source

pub async fn email_info(&self, email: &str) -> Result<EmailInfo, Error>

Syntax, disposability and MX analysis of an email address.

Source

pub async fn validate_email( &self, email: &str, ) -> Result<AdvancedEmailValidation, Error>

Advanced validation including SMTP deliverability checks.

Source

pub async fn validate_email_batch( &self, emails: &[&str], ) -> Result<BatchEmailValidationResponse, Error>

Advanced-validate up to 100 email addresses in a single request.

Source

pub async fn risk_score(&self) -> Result<RiskScore, Error>

Fraud risk score for the caller’s IP.

Source

pub async fn risk_score_ip(&self, ip: &str) -> Result<RiskScore, Error>

Fraud risk score for a specific IP.

Source

pub async fn email_risk_score(&self, email: &str) -> Result<RiskScore, Error>

Fraud risk score for an email address.

Source

pub async fn whois(&self, domain: &str) -> Result<Whois, Error>

Source

pub async fn reverse_dns(&self, ip: &str) -> Result<ReverseDns, Error>

Source

pub async fn forward_dns(&self, hostname: &str) -> Result<ForwardDns, Error>

Source

pub async fn mx_records(&self, domain: &str) -> Result<MxLookup, Error>

Source

pub async fn domain_age(&self, domain: &str) -> Result<DomainAge, Error>

Source

pub async fn domain_age_batch( &self, domains: &[&str], ) -> Result<BatchDomainAgeResponse, Error>

Source

pub async fn rate_limit(&self) -> Result<RateLimitInfo, Error>

Source

pub async fn usage_summary(&self) -> Result<UsageSummary, Error>

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Client

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more