geocaching-api

Geocaching API client library for node.js, _(*1)

Dependencies

geocaching-api

Setup

To setup API, replace your API keys values in config-api file (copied from template) :, _(*2)

cp default-config-api.js config-api.js, _(*3)

Tests

Mocha tests require OAuth token produced after OAUth authorization. Since it requires UI, token should be retrieved in exemple app (in /account page) and copied into config-tokens., _(*4)

cp default-config-tokens.js config-tokens.js, _(*5)

Examples

For a complete, working example, refer to the login example., _(*6)

> cd examples/login
> npm install
> npm start

Tests

> npm run test

Todo

Complete implementation of GC API following official doc: https://api.groundspeak.com/LiveV6/geocaching.svc/help

Credits

Ludovic Valente

License

The ISC License, _(*7)

== Favorite AddFavoritePointToCache GetCacheIdsFavoritedByUser GetCachesFavoritedByUser GetUsersFavoritePoints GetUsersWhoFavoritedCache RemoveFavoritePointFromCache, _(*9)

== Bookmark AddGeocachesToBookmarkList GetBookmarkListByGuid GetBookmarkListsByUserID GetBookmarkListsForUser, _(*10)

== Trackable CreateTrackableLog GetOwnedTrackables GetTrackableLogsByTBCode GetTrackablesByTBCode GetTrackablesByTrackingNumber GetTrackablesInCache GetTrackableTravelList GetUsersTrackables UploadImageToTrackableLog, _(*11)

== Profile GetAnotherUsersProfile GetAPILimits GetMembershipTypes GetYourUserProfile Ping RegisterWP7DeviceTile WindowsPhoneTileSearch GetUserCredentials GetUsersCacheCounts, _(*12)

== Note CreateFieldNoteAndPublish DeleteCacheNote UpdateCacheNote GetUsersCacheNotes, _(*13)

== Waypoint DeleteUserWaypoint SaveUserWaypoint GetUserWaypoints, _(*14)

== Logs GetGeocacheLogsByCacheCode GetUsersGeocacheLogs GetWptLogTypes ?? UploadImageToGeocacheLog, _(*15)

== Souvenirs SearchForSouvenirsByPublicGuid, _(*16)

== caches SearchForGeocaches GetMoreGeocaches GetCacheByTileGuid GetGeocacheDataTypes GetGeocacheStatus GetGeocacheTypes GetAttributeTypesData, _(*17)

== images GetImagesForGeocache GetUserGallery, _(*18)

== PQ GetPocketQueryData GetPocketQueryList GetPocketQueryZippedFile GetFullPocketQueryData, _(*19)

== Others... GeocodeString GetSiteStats GetStatusMessages, _(*20)