{"id":13466273,"url":"https://github.com/fcambus/telize","last_synced_at":"2025-05-16T18:08:28.977Z","repository":{"id":65682498,"uuid":"12268415","full_name":"fcambus/telize","owner":"fcambus","description":"High performance JSON IP and GeoIP REST API (IP Geolocation)","archived":false,"fork":false,"pushed_at":"2023-11-28T09:48:03.000Z","size":275,"stargazers_count":867,"open_issues_count":2,"forks_count":137,"subscribers_count":46,"default_branch":"master","last_synced_at":"2025-04-03T17:14:08.385Z","etag":null,"topics":["api","c","geoip","json","kore"],"latest_commit_sha":null,"homepage":"https://www.telize.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fcambus.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS"}},"created_at":"2013-08-21T11:26:52.000Z","updated_at":"2025-03-23T01:48:50.000Z","dependencies_parsed_at":"2024-01-13T17:59:55.656Z","dependency_job_id":"22b2af64-b3e6-4ebf-9910-e42c5d71331d","html_url":"https://github.com/fcambus/telize","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcambus%2Ftelize","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcambus%2Ftelize/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcambus%2Ftelize/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcambus%2Ftelize/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fcambus","download_url":"https://codeload.github.com/fcambus/telize/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248599560,"owners_count":21131309,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","c","geoip","json","kore"],"created_at":"2024-07-31T15:00:41.861Z","updated_at":"2025-04-12T16:43:25.271Z","avatar_url":"https://github.com/fcambus.png","language":"Go","readme":"\n                               t  e  l  i  z  e\n                           _______________________\n                     ______\\                     /_______\n                    \\\\     \\\\           ___     //      /\n               __    \\ ____  \\   __    /   \\   _____/\\ / ____\n           ___/  \\____/  _//____/  \\___\\___/___\\__   /__/  _//____\n          \\\\__    ____  __/  __     __      ____    ____  __/  __///\n            /      \\_   |/    \\_     /       \\/     /_/   |/    \\_\n          \\\\\\   ___/\\___       /____/\\_______/\\   ___/\\___       /\n      \u003c0(--- \\__/ -h7- \\______/   \\       .    \\__/ ---- \\______/ --(0\u003e\n                           \\      .\\     /.      .\n                            \\      .\\   //      /\n                             \\______\\\\ //______/\n                                      Y\n\n## Description\n\nTelize is a REST API built in Go allowing to get a visitor IP address and\nto query location information from any IP address. It outputs JSON-encoded\nIP geolocation data, and supports both JSON and JSONP.\n\nGeolocation operations are performed using the MaxMind DB Reader for Go\nwhich caches the database in RAM. Therefore, Telize has very minimal\noverhead and should be blazing fast.\n\n## Requirements\n\nTelize requires the following Go libraries:\n\n- chi: lightweight, idiomatic and composable router - https://github.com/go-chi/chi\n- maxminddb-golang: MaxMind DB Reader for Go - https://github.com/oschwald/maxminddb-golang\n\n### GeoIP2 databases\n\nTelize requires the free [GeoLite2 databases][1] from MaxMind.\n\nTelize will look for the `GeoLite2 City` and `GeoLite2 ASN` databases in\n`/var/db/GeoIP` by default.\n\n## Installation\n\nBuild and install with the `go` tool, all dependencies will be automatically\nfetched and compiled:\n\n\tgo build\n\tgo install telize\n\n## Usage\n\nBy default, Telize will bind on localhost, port 8080.\n\n\tUSAGE:\n\t  -host string\n\t    \tSet the server host (default \"127.0.0.1\")\n\t  -port string\n\t    \tSet the server port (default \"8080\")\n\t  -version\n\t    \tDisplay version\n\n## Running Telize at boot time\n\n### Systemd unit file\n\nTelize is bundled with a systemd unit file, see: `systemd/telize.service`\n\nCopy the `systemd/telize.service` file in `/etc/systemd/system` and the Telize\nbinary in `/usr/local/sbin`.\n\nTo launch the daemon at startup, run:\n\n\tsystemctl enable telize\n\n## Making Queries\n\nFor complete API documentation and usage examples, please check the\nproject site.\n\nTelize supports JSONP callbacks.\n\n### Get IP address in Plain text format\n\n- Example: http://127.0.0.1:8080/ip\n\n### Get IP address in JSON format\n\n- Example (JSON): http://127.0.0.1:8080/jsonip\n- Example (JSONP): http://127.0.0.1:8080/jsonip?callback=getip\n\n### Get IP address location in JSON format\n\nCalling the API endpoint without any parameter will return the visitor\nIP address:\n\n- Example (JSON): http://127.0.0.1:8080/location\n- Example (JSONP): http://127.0.0.1:8080/location?callback=getlocation\n\nAppending an IP address as parameter will return location information for\nthe given address:\n\n- Example (JSON): http://127.0.0.1:8080/location/46.19.37.108\n- Example (JSONP): http://127.0.0.1:8080/location/46.19.37.108?callback=getlocation\n\n## Client Errors\n\nWhen incorrect user input is entered, the server returns an HTTP 400 Error\n(Bad Request), along with a JSON-encoded error message.\n\n- Code 401: Input string is not a valid IP address\n\n## Telize and proxies\n\nTelize handles the 'X-Forwarded-For' HTTP header if present, and returns\ndata for the first IP address of the list.\n\n## CORS Support (Cross-origin resource sharing)\n\nTelize has CORS enabled by default with the following policy:\n\n\tAccess-Control-Allow-Origin: *\n\n## Timezone offsets\n\nSince version 3.0.0, Telize now dynamically calculates timezone offsets\n(UTC time offset) and adds data to the payload.\n\n## License\n\nTelize is released under the BSD 2-Clause license. See `LICENSE` file\nfor details.\n\n## Author\n\nTelize is developed by Frederic Cambus.\n\n- Site: https://www.cambus.net\n\n## Resources\n\nProject homepage: https://www.telize.com\n\nLatest tarball release: https://www.statdns.com/telize/telize-3.1.1.tar.gz\n\nGitHub: https://github.com/fcambus/telize\n\n[1]: https://dev.maxmind.com/geoip/geoip2/geolite2/\n","funding_links":[],"categories":["Go","C","c","Resources"],"sub_categories":["Miscellaneous"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffcambus%2Ftelize","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffcambus%2Ftelize","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffcambus%2Ftelize/lists"}