What is an API?
An API is a tool that enables extraction, sharing, and integration of data across applications.
What does the Clearinghouse API do?
The Clearinghouse API enables retrieval of data from Clearinghouse cases and documents in a way that can be manipulated or displayed elsewhere.
For example, you might use the Clearinghouse API to download data about a set of cases that can then be reorganized and redisplayed elsewhere in a way that makes it easier for you to analyze. You might also use the Clearinghouse API to redisplay Clearinghouse case summaries and information on a different website. For example, if the Clearinghouse has information about cases that your organization has worked on, you could redisplay Clearinghouse case entries about those cases on your organization’s website.
What does the API do that the Clearinghouse search page doesn’t do?
At its most basic, the API allows you to access the same information that you can via a search on the Clearinghouse website, but it permits extraction and reuse/redisplay of that data into a format that might better serve your research purposes.
Who can use the Clearinghouse API?
The Clearinghouse API is available to use for research or educational purposes. Note, however, that some computer programming knowledge is necessary to use the API. If you’d like to request a token for API use, please do so here. If you’re not sure whether the API is right for you, please ask us: firstname.lastname@example.org.
To learn more about how to use the API, please check out our Clearinghouse API Guide.