1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
//! # ipgeolocate
//! Get IP address geolocation information freely.
//!
//! ```
//! ipgeolocate = "0.3.5"
//! ```
//! Add to `Cargo.toml`.
//!
//! ## Example
//! Because `ipgeolocate` is an async library, you need an async runtime like [`tokio`](https://crates.io/crates/tokio) or [`async-std`](https://crates.io/crates/async-std) to run.
//!
//! Using `ipgeolocate` is really quite easy:
//! ```
//! use ipgeolocate::{Locator, Service};
//!
//! // Prints the city where 1.1.1.1 is.
//! #[tokio::main]
//! async fn main() {
//! let service = Service::IpApi;
//! let ip = "1.1.1.1";
//!
//! match Locator::get(ip, service).await {
//! Ok(ip) => println!("{} - {} ({})", ip.ip, ip.city, ip.country),
//! Err(error) => println!("Error: {}", error),
//! };
//! }
//! ```
//!
//! This and more examples are found in the examples directory.
//!
//! ## Query Limits
//! Each service included in this library has a weekly, hourly, or monthly limit.
//! Some have more free queries, but are less reliable.
//!
//! Here are the query limits:
//!
//! | Service | Limit |
//! | --------- | ------------------------- |
//! | [ipwhois.app](https://freegeoip.app/) | 10,000/month |
//! | [freegeoip.app](https://ipwhois.app/) | 15,000/hour |
//! | [ip-api.com](https://ip-api.com/) | 45/minute |
//! | [ipapi.co](https://ipapi.co/) | 1,000/day (30,000/month) |
//!
//! You can use each of these just by running the function of the same name.
//!
//! freegeoip.app is not recommended because it has issues reliably getting the correct latitude and longitude for IP addresses.
//!
//! ## Fields
//! The API can get these fields about IP addresses.
//!
//! - [`ip`](crate::Locator::ip)
//! - [`latitude`](crate::Locator::latitude)
//! - [`longitude`](crate::Locator::longitude)
//! - [`city`](crate::Locator::city)
//! - [`region`](crate::Locator::region)
//! - [`country`](crate::Locator::country)
//! - [`timezone`](crate::Locator::timezone)
//!
//! ## Credits
//! Grant Handy <grantshandy@gmail.com>
//!
//! APIs included:
//! - [ipwhois.app](https://freegeoip.app/)
//! - [freegeoip.app](https://ipwhois.app/)
//! - [ip-api.com](https://ip-api.com/)
//! - [ipapi.co](https://ipapi.co/)
//!
//! Written with love, in Rust.
//!
use reqwest::get;
use serde_json::Value;
use std::fmt;
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use tracing::debug;
/// Services (apis) that can be used for accessing geolocation data.
#[derive(Debug, Clone, Copy)]
pub enum Service {
IpWhois,
IpApi,
IpApiCo,
FreeGeoIp,
}
impl fmt::Display for Service {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
Service::IpWhois => {
write!(f, "ipwhois")
}
Service::IpApi => {
write!(f, "ipapi")
}
Service::IpApiCo => {
write!(f, "ipapico")
}
Service::FreeGeoIp => {
write!(f, "freegeoip")
}
}
}
}
#[derive(Debug, Clone)]
/// A general ipgeolocate error for requests.
pub enum GeoError {
HttpError(String),
ParseError(String),
}
impl std::error::Error for GeoError {}
impl fmt::Display for GeoError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
GeoError::HttpError(error) => {
write!(f, "HTTP Request Error: {}", error)
}
GeoError::ParseError(error) => {
write!(f, "JSON Parsing Error: {}", error)
}
}
}
}
/// This is the main struct for making requests to the APIs.
#[derive(Debug, Clone)]
pub struct Locator {
/// Returns the IP address.
pub ip: String,
/// Latitude of the IP address.
pub latitude: String,
/// Longitude of the IP address.
pub longitude: String,
/// City of the IP address.
pub city: String,
/// Region or state of the IP address.
pub region: String,
/// Country of the IP address.
pub country: String,
/// Timezone of the IP address.
pub timezone: String,
/// ISP of the IP address
pub isp: String,
}
impl Locator {
/// Gets IP information from an [`Ipv4Addr`]
pub async fn get_ipv4(ip: Ipv4Addr, service: Service) -> std::result::Result<Self, GeoError> {
Locator::get(&ip.to_string(), service).await
}
/// Gets IP information from an [`Ipv6Addr`]
pub async fn get_ipv6(ip: Ipv6Addr, service: Service) -> std::result::Result<Self, GeoError> {
Locator::get(&ip.to_string(), service).await
}
/// Gets IP information from an [`IpAddr`]
pub async fn get_ipaddr(ip: IpAddr, service: Service) -> std::result::Result<Self, GeoError> {
Locator::get(&ip.to_string(), service).await
}
/// [`IpAddr`]: std::net::IpAddr
/// [`Ipv4Addr`]: std::net::Ipv4Addr
/// [`Ipv6Addr`]: std::net::Ipv6Addr
/// Gets IP information from just a string (not recommended for most uses)
pub async fn get(ip: &str, service: Service) -> std::result::Result<Self, GeoError> {
match service {
Service::IpWhois => Locator::ipwhois(ip).await,
Service::IpApi => Locator::ipapi(ip).await,
Service::IpApiCo => Locator::ipapico(ip).await,
Service::FreeGeoIp => Locator::freegeoip(ip).await,
}
}
async fn freegeoip(ip: &str) -> std::result::Result<Self, GeoError> {
let url = format!("https://freegeoip.app/json/{}", ip);
let response = match get(&url).await.unwrap().text().await {
Ok(response) => response,
Err(_) => {
return Err(GeoError::HttpError(
"Couldn't connect to freegeoip.app".to_string(),
))
}
};
// Turn the data into parsed_json
let parsed_json: Value = match serde_json::from_str(&response) {
Ok(parsed_json) => parsed_json,
Err(error) => {
return Err(GeoError::ParseError(format!(
"Couldn't parse json: {}",
error
)));
}
};
// Get latitude from parsed_json
let latitude = match &parsed_json["latitude"] {
Value::Number(latitude) => latitude,
_ => {
return Err(GeoError::ParseError(
"Unable to find latitude in parsed JSON".to_string(),
))
}
};
// Get longitude from parsed_json
let longitude = match &parsed_json["longitude"] {
Value::Number(longitude) => longitude,
_ => {
return Err(GeoError::ParseError(
"Unable to find longitude in parsed JSON".to_string(),
));
}
};
let city = match &parsed_json["city"] {
Value::String(city_str) => city_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find city in parsed JSON".to_string(),
));
}
};
let region = match &parsed_json["region_name"] {
Value::String(region_str) => region_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find region in parsed JSON".to_string(),
));
}
};
let country = match &parsed_json["country_name"] {
Value::String(country_str) => country_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find country in parsed JSON".to_string(),
));
}
};
let timezone = match &parsed_json["time_zone"] {
Value::String(timezone_str) => timezone_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find timezone in parsed JSON".to_string(),
));
}
};
let ip = ip.to_string();
let latitude = latitude.to_string();
let longitude = longitude.to_string();
let city = city.to_string();
let region = region.to_string();
let country = country.to_string();
let timezone = timezone.to_string();
let isp = String::default();
let result = Locator {
ip,
latitude,
longitude,
city,
region,
country,
timezone,
isp,
};
Ok(result)
}
async fn ipwhois(ip: &str) -> std::result::Result<Self, GeoError> {
let url = format!("http://ipwhois.app/json/{}", ip);
let response = match get(&url).await.unwrap().text().await {
Ok(response) => response,
Err(_) => {
return Err(GeoError::HttpError(
"Couldn't connect to ipwhois.app".to_string(),
))
}
};
// Turn the data into parsed_json
let parsed_json: Value = match serde_json::from_str(&response) {
Ok(parsed_json) => parsed_json,
Err(error) => {
return Err(GeoError::ParseError(format!(
"Error parsing json: {}",
error
)));
}
};
let success = match &parsed_json["success"] {
Value::Bool(latitude_str) => latitude_str,
_ => {
return Err(GeoError::ParseError(
"Cannot find success in JSON".to_string(),
));
}
};
if !success {
return Err(GeoError::ParseError(
"You've hit the monthly limit".to_string(),
));
}
// Get latitude from parsed_json
let latitude_str = match &parsed_json["latitude"] {
Value::String(latitude_str) => latitude_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find latitude in parsed JSON".to_string(),
));
}
};
// Get longitude from parsed_json
let longitude_str = match &parsed_json["longitude"] {
Value::String(longitude_str) => longitude_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find longitude in parsed JSON".to_string(),
));
}
};
let city_str = match &parsed_json["city"] {
Value::String(city_str) => city_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find city in parsed JSON".to_string(),
));
}
};
let region_str = match &parsed_json["region"] {
Value::String(region_str) => region_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find region in parsed JSON".to_string(),
));
}
};
let country_str = match &parsed_json["country"] {
Value::String(country_str) => country_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find country in parsed JSON".to_string(),
));
}
};
let timezone_str = match &parsed_json["timezone"] {
Value::String(timezone_str) => timezone_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find timezone in parsed JSON".to_string(),
));
}
};
let ip = ip.to_string();
let latitude = latitude_str.to_string();
let longitude = longitude_str.to_string();
let city = city_str.to_string();
let region = region_str.to_string();
let country = country_str.to_string();
let timezone = timezone_str.to_string();
let result = Locator {
ip,
latitude,
longitude,
city,
region,
country,
timezone,
isp: String::default(),
};
Ok(result)
}
async fn ipapi(ip: &str) -> std::result::Result<Self, GeoError> {
let url = format!("http://ip-api.com/json/{}", ip);
let response = match get(&url).await.unwrap().text().await {
Ok(response) => response,
Err(_) => {
return Err(GeoError::HttpError(
"Couldn't connect to ip-api.com".to_string(),
))
}
};
// Turn the data into parsed_json
let parsed_json: Value = match serde_json::from_str(&response) {
Ok(parsed_json) => parsed_json,
Err(error) => {
return Err(GeoError::ParseError(format!(
"Couldn't parse json: {}",
error
)));
}
};
debug!("ipgeolocate return object looks like: {}", parsed_json);
// Get latitude from parsed_json
let latitude = match &parsed_json["lat"] {
Value::Number(latitude) => latitude,
_ => {
return Err(GeoError::ParseError(
"Unable to find latitude in parsed JSON".to_string(),
));
}
};
// Get longitude from parsed_json
let longitude = match &parsed_json["lon"] {
Value::Number(longitude) => longitude,
_ => {
return Err(GeoError::ParseError(
"Unable to find longitude in parsed JSON".to_string(),
));
}
};
let city = match &parsed_json["city"] {
Value::String(city_str) => city_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find city in parsed JSON".to_string(),
));
}
};
let region = match &parsed_json["regionName"] {
Value::String(region_str) => region_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find region in parsed JSON".to_string(),
));
}
};
let country = match &parsed_json["country"] {
Value::String(country_str) => country_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find country in parsed JSON".to_string(),
));
}
};
let timezone = match &parsed_json["timezone"] {
Value::String(timezone_str) => timezone_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find timezone in parsed JSON".to_string(),
));
}
};
let isp = match &parsed_json["isp"] {
Value::String(isp) => isp,
_ => {
return Err(GeoError::ParseError(
"Unable to find timezone in parsed JSON".to_string(),
));
}
};
let ip = ip.to_string();
let latitude = latitude.to_string();
let longitude = longitude.to_string();
let city = city.to_string();
let region = region.to_string();
let country = country.to_string();
let timezone = timezone.to_string();
let isp = isp.to_string();
let result = Locator {
ip,
latitude,
longitude,
city,
region,
country,
timezone,
isp,
};
Ok(result)
}
async fn ipapico(ip: &str) -> std::result::Result<Self, GeoError> {
let url = format!("https://ipapi.co/{}/json/", ip);
let response = match get(&url).await.unwrap().text().await {
Ok(response) => response,
Err(_) => {
return Err(GeoError::HttpError(
"Couldn't connect to ipapi.co".to_string(),
))
}
};
// Turn the data into parsed_json
let parsed_json: Value = match serde_json::from_str(&response) {
Ok(parsed_json) => parsed_json,
Err(error) => {
return Err(GeoError::ParseError(format!(
"Couldn't parse json: {}",
error
)));
}
};
// Get latitude from parsed_json
let latitude = match &parsed_json["latitude"] {
Value::Number(latitude) => latitude,
_ => {
return Err(GeoError::ParseError(
"Unable to find latitude in parsed JSON".to_string(),
))
}
};
// Get longitude from parsed_json
let longitude = match &parsed_json["longitude"] {
Value::Number(longitude) => longitude,
_ => {
return Err(GeoError::ParseError(
"Unable to find longitude in parsed JSON".to_string(),
));
}
};
let city = match &parsed_json["city"] {
Value::String(city_str) => city_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find city in parsed JSON".to_string(),
));
}
};
let region = match &parsed_json["region"] {
Value::String(region_str) => region_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find region in parsed JSON".to_string(),
));
}
};
let country = match &parsed_json["country_name"] {
Value::String(country_str) => country_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find country in parsed JSON".to_string(),
));
}
};
let timezone = match &parsed_json["timezone"] {
Value::String(timezone_str) => timezone_str,
_ => {
return Err(GeoError::ParseError(
"Unable to find timezone in parsed JSON".to_string(),
));
}
};
let ip = ip.to_string();
let latitude = latitude.to_string();
let longitude = longitude.to_string();
let city = city.to_string();
let region = region.to_string();
let country = country.to_string();
let timezone = timezone.to_string();
let isp: String = String::default();
let result = Locator {
ip,
latitude,
longitude,
city,
region,
country,
timezone,
isp,
};
Ok(result)
}
}