Api endpoints
kumy edited this page Jun 20, 2019
·
13 revisions
| Endpoint | Description | Access | Example |
|---|---|---|---|
| /{$gk} | Redirect to the geokrety page at geokrety.org | public | https://api.geokretymap.org/GKB580 |
| /{$gkid} | Redirect to the geokrety page at geokrety.org | public | https://api.geokretymap.org/46464 |
| /gkimage/{$imagename} | Proxy and cache image from geokrety.org | public | https://api.geokretymap.org/gkimage/14097735378mgfc.png |
| /gk/{$gkid} | Basic by gkid | public | https://api.geokretymap.org/gk/46464 |
| /gk/{$gkid}/avatar | GeoKret Avatar including picture | public | https://api.geokretymap.org/gk/46464/avatar |
| /gk/{$gkid}/details | Full by gkid | public | https://api.geokretymap.org/gk/46464/details |
| /wpt/{$wpt} | Basic by waypoint | public | https://api.geokretymap.org/wpt/GC5BRQK |
| /wpt/{$wpt}/details | Full by waypoint | public | https://api.geokretymap.org/wpt/GC5BRQK/details |
| /ownername/{$ownername} | Basic by ownername | public | https://api.geokretymap.org/ownername/kumy |
| /ownername/{$ownername}/avatar | Users all GK moves | public | https://api.geokretymap.org/ownername/kumy/avatar |
| /nr/{$nr} | Basic by Secret Code
|
public | https://api.geokretymap.org/nr/THESECRET |
| /nr2id/{$nr} | Get only the corresponding {$gkid} ; not the full .xml | public | https://api.geokretymap.org/nr2id/THESECRET |
| /gk/{$gkid}/dirty | Refresh by gkid | public | https://api.geokretymap.org/gk/46464/dirty |
| /gk/{$gkid}/details/dirty | Refresh by gkid | public | https://api.geokretymap.org/gk/46464/details/dirty |
| /gk/details/{$modifiedsince} | Get geokrety details which where updated since {$modifiedsince}. Consumed by /fetch/master
|
public | https://api.geokretymap.org/gk/details/2016-06-23 |
| /geojson?latTL=&lonTL=&latBR=&lonBR=[&limit=][&dayFrom=<days-from-today][&daysTo=][&newer=1][&older=1][&ghosts=1][&ownername=][&missing=1][&details=1] | Get geokrety positions as Geojson | public | https://api.geokretymap.org/geojson?latTL=89.456&lonTL=508.359&latBR=-80.058&lonBR=-553.359&limit=100&daysFrom=0&daysTo=-1&ownername=kumy |
| /stats | Stats about the replication process | public | https://api.geokretymap.org/stats |
| /fetch | Fetch updated GK from geokrety.org (limit 10 days) | private | https://api.geokretymap.org/fetch |
| /fetch/details | Fetch updated GK details from geokrety.org | private | https://api.geokretymap.org/fetch/details |
| /fetch/master | Fetch updated GK details from a master node. Defaults to api.geokrety.org
|
private | https://api.geokretymap.org/fetch/master |
| /merge | Merge updated GK from pending to prod. Also export as a single file the detailed view. | private | https://api.geokretymap.org/merge |
| /merge/details | Merge updated GK details from pending to prod. Also export as a single file the detailed view. | private | https://api.geokretymap.org/merge/details |
| /optimize | Optimize / compress the geokrety database |
private | https://api.geokretymap.org/optimize |
| /optimize/details | Optimize / compress the geokrety-details database |
private | https://api.geokretymap.org/optimize/details |
| /backup | Backup the geokrety database |
private | https://api.geokretymap.org/backup |
| /backup/details | Backup the geokrety-details database |
private | https://api.geokretymap.org/backup/details |
| /export | Export the geokrety database as an xml file. Consumed by /fetch/master
|
private | https://api.geokretymap.org/export |
| /export/details | Export the geokrety-details database as an xml file. Consumed by /fetch/master
|
private | https://api.geokretymap.org/export/details |
| /graphs/ | Update graphs on the geokrety database |
private | https://api.geokretymap.org/graphs/ |
| /export2.php?gkid={$gkid1}[,{$gkid2}] | Alias for Basic by gkid(s). (details parameter return the full GeoKret(y) entry (including logs) |
public | https://api.geokretymap.org/export2.php?gkid=46464,46465,46466&details |
| /export-details.php?gkid={$gkid} | Alias for Full by gkid. (deprecated) | public | https://api.geokretymap.org/export-details.php?gkid=46464 |
| /nr2id.php?nr={$nr} | Alias for Basic by Secret Code. (deprecated) |
public | https://api.geokretymap.org/nr2id.php?nr=THESECRET |
