Ipify

What

Ipify is a simple Public IP Address API, it returns your public IP Address in plain text.

Sample Configuration

json

{
  "type": "ipify",
  "style": "diamond",
  "foreground": "#ffffff",
  "background": "#c386f1",
  "leading_diamond": "",
  "trailing_diamond": "",
  "template": "{{ .IP }}",
  "properties": {
    "cache_timeout": 5,
    "http_timeout": 1000
  }
}

yaml

type: ipify
style: diamond
foreground: "#ffffff"
background: "#c386f1"
leading_diamond: 
trailing_diamond: 
template: "{{ .IP }}"
properties:
  cache_timeout: 5
  http_timeout: 1000

toml

type = "ipify"
style = "diamond"
foreground = "#ffffff"
background = "#c386f1"
leading_diamond = ""
trailing_diamond = ""
template = "{{ .IP }}"

[properties]
cache_timeout = 5
http_timeout = 1_000

Properties

Name	Type	Default	Description
url	string	https://api.ipify.org	The Ipify URL, by default IPv4 is used, use https://api64.ipify.org for IPv6
http_timeout	int	20	in milliseconds - how long may the segment wait for a response of the ipify API
cache_timeout	int	10	in minutes - How long you want your IP address cached

Template (info)

default template

{{ .IP }}

Properties

Name	Type	Description
.IP	string	Your external IP address