myip-foo 1.0.0

Official Rust client for myip.foo - free IP lookup API with geolocation
Documentation 
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

# myip-foo

Official Rust client for [myip.foo](https://myip.foo) - a free, privacy-focused IP lookup API.

[![Crates.io](https://img.shields.io/crates/v/myip-foo.svg)](https://crates.io/crates/myip-foo)
[![Documentation](https://docs.rs/myip-foo/badge.svg)](https://docs.rs/myip-foo)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Features

- Async/await support with tokio
- Full type definitions with serde
- Dual-stack IPv4/IPv6 support
- Connection type detection
- No API key required

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
myip-foo = "1.0"
tokio = { version = "1.0", features = ["full"] }
```

## Quick Start

```rust
use myip_foo::{get_ip, get_ip_data};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Get plain IP
    let ip = get_ip().await?;
    println!("IP: {}", ip);

    // Get full data with geolocation
    let data = get_ip_data().await?;
    println!("IP: {}", data.ip);
    println!("City: {}", data.location.city);
    println!("Country: {}", data.location.country);
    println!("ISP: {}", data.network.isp);

    Ok(())
}
```

## API Reference

### Functions

#### `get_ip() -> Result<String>`
Returns your IP address as plain text.

#### `get_ip_data() -> Result<IpData>`
Returns full IP data including geolocation.

#### `get_dual_stack() -> Result<DualStackData>`
Returns both IPv4 and IPv6 addresses using dedicated endpoints.

#### `get_connection_type() -> Result<ConnectionTypeData>`
Detects if connection is residential, VPN, or datacenter.

#### `get_headers() -> Result<HashMap<String, String>>`
Returns all HTTP headers as seen by the server.

#### `get_user_agent() -> Result<String>`
Returns your user agent string.

### Types

```rust
pub struct IpData {
    pub ip: String,
    pub ip_type: String,           // "IPv4" or "IPv6"
    pub hostname: Option<String>,
    pub connection_type: Option<String>,  // "residential", "vpn", "datacenter", "tor"
    pub location: Location,
    pub network: Network,
    pub cloudflare: Cloudflare,
}

pub struct DualStackData {
    pub ipv4: Option<String>,
    pub ipv6: Option<String>,
}

pub struct ConnectionTypeData {
    pub ip: String,
    pub connection_type: String,  // "residential", "vpn", "datacenter", "unknown"
}
```

## Examples

### Get Dual-Stack IPs

```rust
use myip_foo::get_dual_stack;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let dual = get_dual_stack().await?;

    if let Some(ipv4) = dual.ipv4 {
        println!("IPv4: {}", ipv4);
    }
    if let Some(ipv6) = dual.ipv6 {
        println!("IPv6: {}", ipv6);
    }

    Ok(())
}
```

### Check Connection Type

```rust
use myip_foo::get_connection_type;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let conn = get_connection_type().await?;
    println!("Connection: {} ({})", conn.connection_type, conn.ip);

    Ok(())
}
```

## Dual-Stack Endpoints

The `get_dual_stack()` function uses dedicated subdomains:

- `ipv4.myip.foo/ip` - Returns IPv4 only (A record)
- `ipv6.myip.foo/ip` - Returns IPv6 only (AAAA record)

## Privacy

myip.foo does not log IP addresses or use cookies. See [Privacy Policy](https://myip.foo/privacy.html).

## Links

- **Website:** [myip.foo](https://myip.foo)
- **API Docs:** [myip.foo/api-docs](https://myip.foo/api-docs.html)
- **GitHub:** [myip-packages](https://github.com/virtualox/myip-packages)

## License

MIT License - see [LICENSE](../../LICENSE) for details.