2-1-1 resources data is accessed using an application programming interface, or API. To learn more about what is and how it can be used, click here. The developer portal includes three APIs: search, export and resources. All APIs are accessed from APIs on the main menu.
The Search API returns services matching keywords entered by a user. Similar to Google search, developers submit one or more terms such as shelter or housing, location such as city or zip code, and distance from location. Services matching the terms are returned with facets, such as service category and area, allowing for refinement of search results. Developers interested in building websites or applications that show data in the context of their customers would use this Search API.
The Query API allows developers to query the 2-1-1 resources repository, returning data on contacts, services, locations and organizations. The Query API aligns to Open Referral's Human Services Data API protocols suite, resulting in increased access and use of the Repository. Developers interested in integrating external systems or applications would typically use the Query API.
Export API The Export API allows authorized users to perform bulk export operations on the 2-1-1 resource repository. The API returns all services and locations of organizations selected for export. The API includes several filters to refine the export, and page and size controls to manage results. A typical use of this API would be importing data into external systems.