Each GivingData site contains detailed, dynamic help documentation for all of the available Open APIs. The help documentation page allows you to view detailed information about each API method, including the parameters it accepts and the return data types. Using your API key, you can even try out API methods in real time. The dynamic help documentation for your site can be found at the following URL:
https://YOUR_GD_SUBDOMAIN.givingdata.com/api/help
The dynamic help documentation page on your site is always up-to-date with the version of GivingData deployed to your site. Any new APIs we release in the future will automatically become available when your site is updated.
You can also view the help documentation on our demo site. Please note that you will not be able to test API methods on this site using your API Key and that this site may not always be running the same version of GivingData as your site..
https://demo.givingdata.com/api/help
For each API method available you can view:
The parameters (or inputs) accepted
The data type returned including the specifications for each property
The “Permission” required to access the method
You can also enter your API Key on our documentation page to test out API methods directly in the browser. Please note that these APIs connect to real data, not test data. Any updates you make will be reflected in your GivingData site. To authorize using your API Key, click the “Authorize” and enter your API Key in the modal that appears.
Once you have authorized, you can now click on the “Try it out” button next to any API method. Enter any required parameters and click “Execute” to see the results.
