public-ip-address is a simple Rust library for performing public IP lookups from over a dozen of various services.
It provides a unified interface to fetch public IP address and geolocation information from multiple providers. Arbitrary IP address lookup and access API keys are supported for certain providers. The library provides an asynchronous and blocking interfaces to make it easy to integrate with other async codebase.
The library also includes caching functionality to improve performance for repeated lookups and minimize reaching rate-limiting thresholds. The cache file can be encrypted when enabled through a feature flag for additional privacy.
Add the following to your Cargo.toml file:
[dependencies]
public-ip-address = { version = "0.3" }
# with cache encryption enabled
public-ip-address = { version = "0.3", features = ["encryption"] }
# with `async` disabled
public-ip-address = { version = "0.3", features = ["blocking"] }
The simplest way to use this library is to call the perform_lookup() function, which returns a Result with a LookupResponse.
use std::error::Error;
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
// Perform my public IP address lookup
let result = public_ip_address::perform_lookup(None).await?;
println!("{}", result);
Ok(())
}
With blocking interface enabled:
use std::error::Error;
fn main() -> Result<(), Box<dyn Error>> {
// Perform my public IP address lookup
let result = public_ip_address::perform_lookup(None)?;
println!("{}", result);
Ok(())
}
More examples can be found in the examples directory. And run them with the following command:
cargo run --example <example_name>
Running the examples with the blocking feature enabled:
cargo run --example <example_name> --features blocking
| Provider | URL | Rate Limit | API Key | Target Lookup |
|---|---|---|---|---|
| FreeIpApi | https://freeipapi.com | 60 / minute | โ๏ธ | โ๏ธ |
| IfConfig | https://ifconfig.co | 1 / minute | โ๏ธ | |
| IpInfo | https://ipinfo.io | 50000 / month | โ๏ธ | โ๏ธ |
| MyIp | https://my-ip.io | ? / day | ๏ธ | ๏ธ |
| IpApiCom | https://ip-api.com | 45 / minute | โ๏ธ | |
| IpWhoIs | https://ipwhois.io | 10000 / month | ๏ธ | โ๏ธ |
| IpApiCo | https://ipapi.co | 30000 / month | โ๏ธ | |
| IpApiIo | https://ip-api.io | ? / day | โ๏ธ | โ๏ธ |
| IpBase | https://ipbase.com | 10 / hour | โ๏ธ | โ๏ธ |
| IpLocateIo | https://iplocate.io | 50 / day | โ๏ธ | โ๏ธ |
| IpLeak | https://ipleak.net | ? / day | ๏ธ | โ๏ธ |
| Mullvad | https://mullvad.net | ? / day | ๏ธ | ๏ธ |
| AbstractApi | https://abstractapi.com | 1000 / day | โ๏ธ | โ๏ธ |
| IpGeolocation | https://ipgeolocation.io | 1000 / day | โ๏ธ | โ๏ธ |
| IpData | https://ipdata.co | 1500 / day | โ๏ธ | โ๏ธ |
| Ip2Location | https://ip2location.io | 500 / day (with key 30000 / month) | โ๏ธ | โ๏ธ |
| MyIpCom | https://myip.com | unlimited | ๏ธ | ๏ธ |
| GetJsonIp | https://getjsonip.com | unlimited | ๏ธ | ๏ธ |
| Ipify | https://www.ipify.org | unlimited | ๏ธ | ๏ธ |
- Initial release
- Add more providers
- Add support for additional providers with API key
- Add reverse lookup feature
- Add asynchronous and synchronous interface support
- Bulk lookup
- Offline reverse lookup
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contributions are welcome! Please submit a pull request.
If you encounter any problems or have any questions, please open an issue in the GitHub repository.
0 Oct 23, 2022
75 Dec 1, 2022
7 Mar 1, 2023
153 Dec 27, 2022
22 Aug 7, 2023
18 Jun 18, 2022
6 Nov 13, 2023
4 Nov 21, 2023
1k Dec 30, 2022
1 Dec 28, 2022
82 Nov 10, 2022
99 Dec 22, 2022
4 Nov 7, 2022
306 Jul 12, 2023
4 Aug 14, 2024
1.6k Dec 30, 2022
5 Aug 16, 2024
6 Sep 30, 2022
127 Dec 5, 2022