Skip to content

IP-API

Displays your current IP address information, from IP-API.com.

Note: IP-API.com has a free-plan rate limit of 120 requests per minute.

Configuration

ipapi:
  colors:
    name: red
    value: white
  # Optional  
  args:
    - "ip"
    - "isp"
    - "as"
    - "city"
    - "regionName"
    - "country"
    - "continent"
    - "coordinates"
    - "organization"
    - "timezone"
    - "reverseDNS"
  enabled: true
  position:
    top: 1
    left: 2
    height: 1
    width: 1
  refreshInterval: 150s

Attributes

Name Value
colors.name
Optional The default colour for the row names.
Any X11 color name or long-form hex value (i.e.: #ff0000).
colors.value
Optional The default colour for the row values.
Any X11 color name or long-form hex value (i.e.: #ff0000).
args
Optional The data to display and the order to display it in.
See args table below.

Args

Value Description Example
ip IP address 173.194.67.94
isp ISP name Google
as AS number and organization, separated by space (RIR). Empty for IP blocks not being announced in BGP tables. AS15169 Google Inc.
asName AS name (RIR). Empty for IP blocks not being announced in BGP tables. GOOGLE
district District (subdivision of city) Old Farm District
city City Mountain View
region Region/state short code (FIPS or ISO) CA or 10
regionName Region/state California
country Country name United States
countryCode Two-letter country code ISO 3166-1 alpha-2 US
continent Continent name North America
continentCode Two-letter continent code NA
coordinates Latitude and longitude 37.4192, -122.0574
postalCode Postal code 94043
currency National currency USD
organization Organization name Google
timezone Timezone (tz) America/Los_Angeles
reverseDNS Reverse DNS of the IP wi-in-f94.1e100.net

Source Code

https://github.com/wtfutil/wtf/tree/master/modules/ipaddresses/ipapi