Skip to content

Commit

Permalink
Update code.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ip2location committed Aug 30, 2023
1 parent c1c28b6 commit 1a170a4
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion docs/source/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,38 @@ Retrieve geolocation information for an IP address.
:return: Returns the geolocation information in array. Refer below table for the fields avaliable in the array
:rtype: array
{py:function} getAllAsync(ipAddress)
**RETURN FIELDS**
| Field Name | Description |
| ---------------- | ------------------------------------------------------------ |
| countryShort | Two-character country code based on ISO 3166. |
| countryLong | Country name based on ISO 3166. |
| region | Region or state name. |
| city | City name. |
| isp | Internet Service Provider or company\'s name. |
| latitude | City latitude. Defaults to capital city latitude if city is unknown. |
| longitude | City longitude. Defaults to capital city longitude if city is unknown. |
| domain | Internet domain name associated with IP address range. |
| zipCode | ZIP code or Postal code. [172 countries supported](https://www.ip2location.com/zip-code-coverage). |
| timeZone | UTC time zone (with DST supported). |
| netSpeed | Internet connection type. |
| iddCode | The IDD prefix to call the city from another country. |
| areaCode | A varying length number assigned to geographic areas for calls between cities. [223 countries supported](https://www.ip2location.com/area-code-coverage). |
| weatherStationCode | The special code to identify the nearest weather observation station. |
| weatherStationName | The name of the nearest weather observation station. |
| mcc | Mobile Country Codes (MCC) as defined in ITU E.212 for use in identifying mobile stations in wireless telephone networks, particularly GSM and UMTS networks. |
| mnc | Mobile Network Code (MNC) is used in combination with a Mobile Country Code(MCC) to uniquely identify a mobile phone operator or carrier. |
| mobileBrand | Commercial brand associated with the mobile carrier. You may click [mobile carrier coverage](https://www.ip2location.com/mobile-carrier-coverage) to view the coverage report. |
| elevation | Average height of city above sea level in meters (m). |
| usageType | Usage type classification of ISP or company. |
| addressType | IP address types as defined in Internet Protocol version 4 (IPv4) and Internet Protocol version 6 (IPv6). |
| category | The domain category based on [IAB Tech Lab Content Taxonomy](https://www.ip2location.com/free/iab-categories). |
| district | District or county name. |
| asn | Autonomous system number (ASN). BIN databases. |
| as | Autonomous system (AS) name. |
```

```{py:function} getAllAsync(ipAddress)
Retrieve geolocation information for an IP address asynchronously.
:param str ipAddress: (Required) The IP address (IPv4 or IPv6).
Expand Down

0 comments on commit 1a170a4

Please sign in to comment.