Repository files navigation

This is the Rust client library for theIPinfo.io IP address API.It allows you to look up your own IP address, or get any of the following details for an IP:

• IP Geolocation (city, region, country, postal code, latitude, and longitude)
• ASN (ISP or network operator, associated domain name, and type, such as business, hosting, or company)
• Company data (the name and domain of the business that uses the IP address)
• Carrier details (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)

Check all the data we have for your IP addresshere.

To use IPinfo, add the following to yourCargo.toml file.

[dependencies]ipinfo ="3.1.1"

An access token is required, which can be acquired by signing up for a free accountathttps://ipinfo.io/signup.

The free plan is limited to 50,000 requests per month, and doesn't include some of thedata fields such as the IP type and company information. To get the complete list ofinformation on an IP address and make more requests per day seehttps://ipinfo.io/pricing.

There are several ready-to-run examples located in the/examples directory. These can be run directly, replacing<token> with your access token

cargo run --example lookup --<token>

cargo run --example lookup_batch --<token>

cargo run --example get_map

Thelookup example above looks more or less like

use ipinfo::{IpInfo,IpInfoConfig};#[tokio::main]asyncfnmain(){let config =IpInfoConfig{token:Some("<token>".to_string()),        ..Default::default()};letmut ipinfo =IpInfo::new(config).expect("should construct");let res = ipinfo.lookup("8.8.8.8").await;match res{Ok(r) =>{println!("{} lookup result: {:?}","8.8.8.8", r);},Err(e) =>println!("error occurred: {}",&e.to_string()),}}

• Smart LRU cache for cost and quota savings.
• Structured and type-checked query results.
• Bulk IP address lookup using IPinfobatch API.
• Locate IPs on a World Map.

When looking up an IP address, theresponse includescountry_name which is the country name based on American English,is_eu which returnstrue if the country is a member of the European Union (EU),country_flag which includes the emoji and Unicode of a country's flag,country_currencywhich includes the code and symbol of a country's currency,country_flag_url which returns a public link to the country's flag image as an SVG which can be used anywhere. andcontinent which includes the code and name of the continent.

let r = ipinfo.lookup("8.8.8.8");println!("{}: {}","8.8.8.8", r.country_name)// United Statesprintln!("{}: {:?}","8.8.8.8", r.is_eu)// Some(false)println!("{}: {:?}","8.8.8.8", r.country_flag)// Some(CountryFlag { emoji: "🇺🇸", unicode: "U+1F1FA U+1F1F8" })println!("{}: {:?}","8.8.8.8", r.country_flag_url)// Some(https://cdn.ipinfo.io/static/images/countries-flags/US.svg)println!("{}: {:?}","8.8.8.8", r.country_currency)// Some(CountryCurrency { code: "USD", symbol: "$" })println!("{}: {:?}","8.8.8.8", r.continent)// Some(Continent { code: "NA", name: "North America" })

It is possible to return the country name in other languages, change the EU countries and change the flag emoji or unicode by setting thedefault_countries,default_eu,default_country_flags,default_currencies anddefault_continents when creating theIPinfo client.

let countries ={let json_data =r#"        {            "US": "United States"        }    "#;    serde_json::from_str(json_data).expect("error parsing user-defined JSON!")};let config =IpInfoConfig{default_countries: countries,    ..Default::default()};

There are official IPinfo client libraries available for many languages includingPHP, Go, Java, Ruby, and many popular frameworks such as Django, Rails, and Laravel.There are also many third-party libraries and integrations available for our API.

Thought of something you'd like to see? You can visit the issue trackerto check if it was reported or proposed before, and if not please feel free tocreate an issue or feature request. Ready to start contributing?Thecontributing guide is a good place to start. If you havequestions please feel free to ask.

Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, Reverse IP, hosted domains, and IP type data sets. Our API handles over 40 billion requests a month for 100,000 businesses and developers.