Api documentation – ipstack
Based on your subscription plan and also the options you select for the API request, the ipstack API will respond using a number of different modules and objects. Find below a summary of all available API response objects described.
Scroll left & to navigate
| Response Object | Description |
|---|---|
| ip | Returns the requested Ip. |
| hostname | Returns the hostname the requested IP resolves to, only came back if Hostname Lookup is enabled. |
| type | Returns the Ip type IPv4 or IPv6. |
| continent_code | Returns the two-letter continent code connected using the IP. View all 2-letter continent codes |
| continent_name | Returns the specific continent connected using the IP. |
| country_code | Returns the two-letter country code connected using the IP. Listing of all 2-letter country codes |
| country_name | Returns the specific country connected using the IP. |
| region_code | Returns the location code from the region connected using the IP (e.g. CA for California). |
| region_name | Returns the specific region connected using the IP. |
| city | Returns the specific city connected using the IP. |
| zip | Returns the Zipcode connected using the IP. |
| latitude | Returns the latitude value connected using the IP. |
| longitude | Returns the longitude value connected using the IP. |
| location | [Object] Returns multiple location-related objects |
| location > geoname_id | Returns the initial geoname identifier in compliance using the Geonames Registry. |
| location > capital | Returns the main city city of the nation connected using the IP. |
| location > languages | [Object] Returns an item that contains one or multiple sub-objects per language spoken in the united states connected using the IP. |
| location > languages > code | Returns the two-letter language code for that given language. Listing of all 2-letter language codes |
| location > languages > name | Returns the name (within the API request’s primary language) from the given language. (e.g. Portuguese) |
| location > languages > native | Returns the native name from the given language. (e.g. Português) |
| location > country_flag | Returns an HTTP URL resulting in an SVG-flag icon for that country connected using the IP. |
| location > country_flag_emoji | Returns the emoji icon for that flag of the nation connected using the IP. |
| location > country_flag_emoji_unicode | Returns the unicode worth of the emoji icon for that flag of the nation connected using the IP. (e.g. U+1F1F5 U+1F1F9 for that Portuguese flag) |
| location > calling_code | Returns the calling/dial code of the nation connected using the IP. (e.g. 351) for Portugal. |
| location > is_eu | Returns true or false based on set up county connected using the IP is incorporated in the Eu. |
| time_zone | [Object] Returns an item that contains timezone-related data. |
| time_zone > id | Returns the ID of times zone connected using the IP. (e.g. America/Los_Angeles for PST) |
| time_zone > current_time | Returns the present time and date within the location connected using the IP. (e.g. 2018-03-29T22:31:27-07:00) |
| time_zone > gmt_offset | Returns the GMT offset from the with time focus seconds. (e.g. -25200 for PST’s -7h GMT offset) |
| time_zone > code | Returns the universal code from the with time zone. Listing of all available codes |
| time_zone > is_daylight_saving | Returns true or false based on set up with time zone is recognized as daylight not waste time. |
| currency | [Object] Returns an item that contains currency-related data. |
| currency > code | Returns the three-letter code from the primary currency connected using the IP. Example: USD – Listing of all available currency codes |
| currency > name | Returns the specific given currency. |
| currency > plural | Returns the plural name from the given currency. |
| currency > symbol | Returns the symbol letter from the given currency. |
| currency > symbol_native | Returns the native symbol letter from the given currency. |
| connection | [Object] Returns an item that contains connection-related data. |
| connection > asn | Returns the Autonomous System Number connected using the IP. |
| connection > isp | Returns the specific ISP connected using the IP. |
| security | [Object] Returns an item that contains security-related data. |
| security > is_proxy | Returns true or false based on set up given IP is connected having a proxy. |
| security > proxy_type | Returns the kind of proxy the IP is connected with. View all potential proxy types |
| security > is_crawler | Returns true or false based on set up given IP is connected having a crawler. |
| security > crawler_name | Returns the specific crawler the IP is connected with. |
| security > crawler_type | Returns the kind of crawler the IP is connected with. View all potential crawler types |
| security > is_tor | Returns true or false based on set up given IP is connected using the anonymous Tor system. |
| security > threat_level | Returns the kind of threat level the IP is connected with. View all threat levels |
| security > threat_types | [object] Returns an item that contains all threat types connected using the IP. View all potential threat types |
Resourse: https://ipstack.com/
