Skip to content

Commit bd8ecd2

Browse files
authored
Update README.md
1 parent ab62580 commit bd8ecd2

File tree

1 file changed

+33
-20
lines changed

1 file changed

+33
-20
lines changed

README.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,73 +18,86 @@ import ipapi
1818

1919
```
2020
ipapi.location()
21-
# Gets complete location for your IP address
22-
# {u'city': u'Wilton', u'ip': u'50.1.2.3', u'region': u'California', u'longitude': -121.2429, u'country': u'US', u'latitude': 38.3926, u'timezone': u'America/Los_Angeles', u'postal': u'95693'}
2321
```
22+
*Gets complete location for your IP address*
23+
24+
> {u'city': u'Wilton', u'ip': u'50.1.2.3', u'region': u'California', u'longitude': -121.2429, u'country': u'US', u'latitude': 38.3926, u'timezone': u'America/Los_Angeles', u'postal': u'95693'}
2425
2526
```
2627
ipapi.field('ip')
27-
# Gets my external IP address
28-
# u'50.1.2.3'
2928
```
29+
*Gets my external IP address*
30+
> u'50.1.2.3'
31+
3032

3133
```
3234
ipapi.field('city')
33-
# Gets your city name
34-
# u'Wilton'
3535
```
36+
*Gets your city name*
37+
> u'Wilton'
38+
3639

3740
```
3841
ipapi.field('country')
39-
# Gets your country
40-
# u'US'
4142
```
43+
*Gets your country*
44+
> u'US'
4245
4346
```
4447
ipapi.location('8.8.8.8')
45-
# Gets complete location for IP address 8.8.8.8
46-
# {u'city': u'Mountain View', u'ip': u'8.8.8.8', u'region': u'California', u'longitude': -122.0838, u'country': u'US', u'latitude': 37.386, u'timezone': u'America/Los_Angeles', u'postal': u'94035'}
4748
```
49+
*Gets complete location for IP address 8.8.8.8*
50+
> {u'city': u'Mountain View', u'ip': u'8.8.8.8', u'region': u'California', u'longitude': -122.0838, u'country': u'US', u'latitude': 37.386, u'timezone': u'America/Los_Angeles', u'postal': u'94035'}
51+
4852

4953
```
5054
ipapi.field('city', '8.8.8.8')
51-
# Gets city name for IP address 8.8.8.8
52-
# u'Mountain View'
5355
```
56+
*Gets city name for IP address 8.8.8.8*
57+
> u'Mountain View'
58+
5459

5560
```
5661
ipapi.field('country', '8.8.8.8')
57-
# Gets country for IP address 8.8.8.8
58-
# u'US'
5962
```
63+
*Gets country for IP address 8.8.8.8*
64+
> u'US'
6065
6166
### From command line
6267
```
6368
$ python ipapi.py
64-
{u'city': u'Wilton', u'ip': u'50.1.2.3', u'region': u'California', u'longitude': -121.2429, u'country': u'US', u'latitude': 38.3926, u'timezone': u'America/Los_Angeles', u'postal': u'95693'}
6569
```
70+
> {u'city': u'Wilton', u'ip': u'50.1.2.3', u'region': u'California', u'longitude': -121.2429, u'country': u'US', u'latitude': 38.3926, u'timezone': u'America/Los_Angeles', u'postal': u'95693'}
6671
6772
```
6873
$ python ipapi.py -f ip
69-
50.1.2.3
7074
```
75+
> 50.1.2.3
7176
7277
```
7378
$ python ipapi.py -f city
74-
Wilton
7579
```
80+
> Wilton
7681
7782
```
7883
$ python ipapi.py -i 8.8.8.8
79-
{u'city': u'Mountain View', u'ip': u'8.8.8.8', u'region': u'California', u'longitude': -122.0838, u'country': u'US', u'latitude': 37.386, u'timezone': u'America/Los_Angeles', u'postal': u'94035'}
8084
```
85+
> {u'city': u'Mountain View', u'ip': u'8.8.8.8', u'region': u'California', u'longitude': -122.0838, u'country': u'US', u'latitude': 37.386, u'timezone': u'America/Los_Angeles', u'postal': u'94035'}
8186
8287
```
8388
$ python ipapi.py -i 8.8.8.8 -f city
84-
Mountain View
8589
```
90+
> Mountain View
8691
8792
```
8893
$ python ipapi.py -i 8.8.8.8 -f country
89-
US
9094
```
95+
> US
96+
97+
### With API Key
98+
99+
API key can be specified in the following ways :
100+
101+
1. Inside `ipapi.py` by setting `API_KEY` variable
102+
2. Via command line with the `-k` option
103+
3. As a function argument e.g. `ipapi.field(field='country', ip='8.8.8.8', key='xyz')` or `ipapi.location(ip='8.8.8.8', key='xyz')`

0 commit comments

Comments
 (0)