proxy

WARNING: This is a pre-release version and is not suitable for production use. It is for evaluation purposes only. Please report all bugs by creating a issue, or by contacting us directly.

ip-api cache

A proxy that caches query results from the ip-api.com pro endpoint.

• better performance via multiple keep-alive connections to ip-api servers
• finds the best PoP based on latency
• retries failed requests
• advanced caching for each response field
• automatically batches requests to reduce network requests

Only /json and /batch are supported.

Getting Started

Install on Linux - Debian

• Create a user

adduser --system --disabled-password --disabled-login --home /opt/ip-api-proxy --group ip-api-proxy

• Install the latest version

If you do not have go installed, please see https://golang.org/doc/install.

GOBIN=/opt/ip-api-proxy/ go get -u github.com/ip-api/proxy/cmd/proxy

• Create a config file

/opt/ip-api-proxy/config

Example configuration:

IP_API_KEY=your_api_key
LOG_LEVEL=info

• Create a systemd file

/etc/systemd/system/ip-api-proxy.service

Suggested configuration:

[Unit]
Description=ip-api proxy server
Documentation=https://github.com/ip-api/proxy
After=network.target

[Service]
PermissionsStartOnly=true
LimitNOFILE=1048576
LimitNPROC=512
CapabilityBoundingSet=CAP_NET_BIND_SERVICE
AmbientCapabilities=CAP_NET_BIND_SERVICE
NoNewPrivileges=true
User=ip-api-proxy
WorkingDirectory=/opt/ip-api-proxy
EnvironmentFile=/opt/ip-api-proxy/config
ExecStart=/opt/ip-api-proxy/proxy
Restart=on-failure

[Install]
WantedBy=multi-user.target

• Enable and start the service

systemctl enable ip-api-proxy
systemctl start ip-api-proxy

Usage

Modify your applications to use http://127.0.0.1:8080 instead of http(s)://pro.ip-api.com.

Environment variables