api:geoip

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
api:geoip [2017-07-04T22:59:23Z]
fusl
api:geoip [2018-02-17T14:28:23Z] (current)
kewlfft [Variable parameters] add bl
Line 1: Line 1:
-===== GeoIP API ======+====== Tier 2 GeoIP API =======
 The GeoIP API returns a list of the nearest OpenNIC [[opennic:tier2|Tier 2]] servers. The GeoIP API returns a list of the nearest OpenNIC [[opennic:tier2|Tier 2]] servers.
  
 ===== The API ===== ===== The API =====
 The APIs base URL is at https://api.opennicproject.org/geoip/ The APIs base URL is at https://api.opennicproject.org/geoip/
 +
 +This wiki page is a clone of the [[https://api.opennicproject.org/geoip/?help|?help page]] with some fancy tables and extra glitter.
  
 ===== URL Parameters ===== ===== URL Parameters =====
Line 14: Line 16:
  
 ^ Parameter ^ Function ^ Example ^ ^ Parameter ^ Function ^ Example ^
-list | (default) List servers including name and reliability | <code>87.98.175.85 # ns10.fr # 98.65%+list | (default) List servers including name and reliability | <code>87.98.175.85 # ns10.fr # 98.65%
 62.113.203.55 # ns1.de # 99.41%</code> | 62.113.203.55 # ns1.de # 99.41%</code> |
-bare | Only list the server IP addresses | <code>87.98.175.85+bare | Only list the server IP addresses | <code>87.98.175.85
 62.113.203.55</code> | 62.113.203.55</code> |
-ns | Create a list of nameservers | <code>nameserver 87.98.175.85     # (98.65%) ns10.fr (wil)+ns | Create a list of nameservers | <code>nameserver 87.98.175.85     # (98.65%) ns10.fr (wil)
 nameserver 62.113.203.55    # (99.41%) ns1.de (dfroe)</code> | nameserver 62.113.203.55    # (99.41%) ns1.de (dfroe)</code> |
-resolv | Provide a useable resolv.conf file | <code># This file was generated by OpenNIC 2017-Jul-04 22:32 UTC+resolv | Provide a useable resolv.conf file | <code># This file was generated by OpenNIC 2017-Jul-04 22:32 UTC
 # and shows the most reliable servers near you. # and shows the most reliable servers near you.
 # You may retrieve updates automatically by using: # You may retrieve updates automatically by using:
Line 29: Line 31:
 nameserver 87.98.175.85     # (98.65%) ns10.fr (wil) nameserver 87.98.175.85     # (98.65%) ns10.fr (wil)
 nameserver 62.113.203.55    # (99.41%) ns1.de (dfroe)</code> | nameserver 62.113.203.55    # (99.41%) ns1.de (dfroe)</code> |
-json | Generate JSON data | <code>[{"host":"ns10.fr.dns.opennic.glue","short":"ns10.fr","ip":"87.98.175.85","loc":"FR","miles":617,"kilometers":993,"stat":"98.65","manager":"wil"},...]</code>+json | Generate JSON data | <code>[{"host":"ns10.fr.dns.opennic.glue","short":"ns10.fr","ip":"87.98.175.85","loc":"FR","miles":617,"kilometers":993,"stat":"98.65","manager":"wil"},...]</code>
-jsonp | Generate a JSON array | <code>opennic([{"host":"ns10.fr.dns.opennic.glue","short":"ns10.fr","ip":"87.98.175.85","loc":"FR","miles":617,"kilometers":993,"stat":"98.65","manager":"wil"},...]);</code> |+jsonp | Generate a JSON array | <code>opennic([{"host":"ns10.fr.dns.opennic.glue","short":"ns10.fr","ip":"87.98.175.85","loc":"FR","miles":617,"kilometers":993,"stat":"98.65","manager":"wil"},...]);</code> |
  
 ==== Variable parameters ==== ==== Variable parameters ====
Line 36: Line 38:
  
 ^ Parameter ^ Example Value 1 ^ Example Value 2 ^ Description ^ ^ Parameter ^ Example Value 1 ^ Example Value 2 ^ Description ^
-adm | 2 | 5 | The first x servers will have unique admins (Defaults to 66% of the list) | +adm | 2 | 5 | The first x servers will have unique admins (Defaults to 66% of the list) | 
-ip | 1.2.3.4 | 123.45.67.89 | Provide servers nearest the given IP address | +ip | 1.2.3.4 | 123.45.67.89 | Provide servers nearest the given IP address | 
-res | 2 | 5 | Change the number of results | +res | 2 | 5 | Change the number of results | 
-pct | 95 | 50 | (default=95) Change the threshold percentage for acceptable server reliability, given as a whole integer | +pct | 95 | 50 | (default=95) Change the threshold percentage for acceptable server reliability, given as a whole integer | 
-lat | 50 | -33.45 | Set the reference latitude for your location | +lat | 50 | -33.45 | Set the reference latitude for your location | 
-lon | -50 | 33.45 | Set the reference longitude for your location | +lon | -50 | 33.45 | Set the reference longitude for your location | 
-ipv | 4 | 6 | Specify which class of IP addresses to return. \\ 4 - Only list IPv4 servers \\ 6 - Only list IPv6 servers \\ all - Include both IPv4 and IPv6 servers | +ipv | 4 | 6 | Specify which class of IP addresses to return. \\ 4 - Only list IPv4 servers \\ 6 - Only list IPv6 servers \\ all - Include both IPv4 and IPv6 servers | 
-rnd | true | | Randomize the returned server order (omit this parameter to disable randomization) +rnd | true | false | Randomize the returned server order | 
-wl | all | none | Include whitelist servers in the results. \\ If you specify wl=all, ONLY whitelist servers will be shown. |+wl | all | none | Include whitelist servers in the results. \\ If you specify wl=all, ONLY whitelist servers will be shown. | 
 +^ bl | | | Include blocklist servers in the results | 
 +^ anon | true | false | Return servers with anonymized logs only | 
  
 ==== Examples ==== ==== Examples ====
  • /wiki/data/attic/api/geoip.1499209163.txt.gz
  • Last modified: 3 years ago
  • by fusl