Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghztomash/public-ip-address
Rust crate to retrieve public IP address and geolocation data. 🦀
https://github.com/ghztomash/public-ip-address
crate geolocation geolocation-api ip network-programming public-ip-address rust rust-lang
Last synced: about 1 month ago
JSON representation
Rust crate to retrieve public IP address and geolocation data. 🦀
- Host: GitHub
- URL: https://github.com/ghztomash/public-ip-address
- Owner: ghztomash
- License: apache-2.0
- Created: 2024-03-12T17:46:38.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-25T21:58:34.000Z (7 months ago)
- Last Synced: 2024-05-01T23:33:59.519Z (7 months ago)
- Topics: crate, geolocation, geolocation-api, ip, network-programming, public-ip-address, rust, rust-lang
- Language: Rust
- Homepage:
- Size: 811 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# 🔎 Public IP Address Lookup and Geolocation Information
[](https://crates.io/crates/public-ip-address)
[](https://docs.rs/public-ip-address)
`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.
## Usage
Add the following to your `Cargo.toml` file:
```toml
[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"] }
```
## Example
The simplest way to use this library is to call the `perform_lookup()` function, which returns a `Result` with a `LookupResponse`.
```rust
use std::error::Error;
#[tokio::main]
async fn main() -> Result<(), Box> {
// Perform my public IP address lookup
let result = public_ip_address::perform_lookup(None).await?;
println!("{}", result);
Ok(())
}
```
With `blocking` interface enabled:
```rust
use std::error::Error;
fn main() -> Result<(), Box> {
// 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:
```bash
cargo run --example
```
Running the examples with the `blocking` feature enabled:
```bash
cargo run --example --features blocking
```
## Providers
| Provider | URL | Rate Limit | API Key | Target Lookup |
| --- | --- | --- | --- | --- |
| FreeIpApi | [https://freeipapi.com](https://freeipapi.com) | 60 / minute | ✔️ | ✔️ |
| IfConfig | [https://ifconfig.co](https://ifconfig.co) | 1 / minute | | ✔️ |
| IpInfo | [https://ipinfo.io](https://ipinfo.io) | 50000 / month | ✔️ | ✔️ |
| MyIp | [https://my-ip.io](https://my-ip.io) | ? / day | ️ | ️ |
| IpApiCom | [https://ip-api.com](https://ip-api.com) | 45 / minute | | ✔️ |
| IpWhoIs | [https://ipwhois.io](https://ipwhois.io) | 10000 / month | ️ | ✔️ |
| IpApiCo | [https://ipapi.co](https://ipapi.co) | 30000 / month | | ✔️ |
| IpApiIo | [https://ip-api.io](https://ip-api.io) | ? / day | ✔️ | ✔️ |
| IpBase | [https://ipbase.com](https://ipbase.com) | 10 / hour | ✔️ | ✔️ |
| IpLocateIo | [https://iplocate.io](https://iplocate.io) | 50 / day | ✔️ | ✔️ |
| IpLeak | [https://ipleak.net](https://ipleak.net) | ? / day | ️ | ✔️ |
| Mullvad | [https://mullvad.net](https://mullvad.net) | ? / day | ️ | ️ |
| AbstractApi | [https://abstractapi.com](https://abstractapi.com) | 1000 / day | ✔️ | ✔️ |
| IpGeolocation | [https://ipgeolocation.io](https://ipgeolocation.io) | 1000 / day | ✔️ | ✔️ |
| IpData | [https://ipdata.co](https://ipdata.co) | 1500 / day | ✔️ | ✔️ |
| Ip2Location | [https://ip2location.io](https://ip2location.io) | 500 / day (with key 30000 / month) | ✔️ | ✔️ |
| MyIpCom | [https://myip.com](https://myip.com) | unlimited | ️ | ️ |
| GetJsonIp | [https://getjsonip.com](https://getjsonip.com) | unlimited | ️ | ️ |
| Ipify | [https://www.ipify.org](https://www.ipify.org) | unlimited | ️ | ️ |
## Roadmap
- [x] Initial release
- [x] Add more providers
- [x] Add support for additional providers with API key
- [x] Add reverse lookup feature
- [x] Add asynchronous and synchronous interface support
- [ ] Bulk lookup
- [ ] Offline reverse lookup
## License
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Contributions are welcome! Please submit a pull request.
## Support
If you encounter any problems or have any questions, please open an issue in the GitHub repository.