API Documentation

Basic Information about the API

The Willpath api is designed to be extremely simple for developers to use. We are excited to get your participation and feedback. Let us know if you have questions/suggestions, etc

Application Access to Users

Access to this version of the api can be enabled by checking off "Donate my data to science" under a user's account privacy settings

Rate Limitations
  • At Willpath, we ask that you abide by rate limiting to improve availability/performance for all our developers
  • Not abiding by these limits can result in removal of your application and other penalties
    • Where n = the number of available People with appropriate access, do not exceed the greater of 100 or (n * 2)+1 calls per developer account per hour
    • Cron jobs (which may include multiple calls as noted above) should not set them to be run more-frequently than 1x per hour per developer account
Performance tip
  • You can add an http headers to enable gzip encoding to improve performance/decrease bandwidth:
  • Example: (using curl and gunzip from the command line) 
    • (get all people with science access on willpath updated since Feb 10th, 2012 at 12:36:42 UTC - and pipe the result to gunzip for decompression):
    • curl -u "username:password" -H "Accept-Encoding: gzip,deflate"  https://willpath.com/api/v1/people.json?&updated_since=2012-02-10T12:36:42Z | gunzip