Intergovernmental FRS API
The FRS API exposes several RESTful web services for querying and submitting data with FRS for federal, state, local, and tribal government organizations.
Intergovernmental FRS API Specifications
The technical details of the FRS API are documented in the FRS Swagger pages:
- Pre-production Query API Swagger Page (for testing purposes)
- Pre-production Submit API Swagger Page (for testing purposes)
- Production Query API Swagger Page
- Production Submit API Swagger Page
Business Users - it is recommended to use the Swagger pages for an explanation of the data elements in FRS and inform how to use the open (no sign-up required) FRS API hosted in Envirofacts.
How to Connect
For federal, state, local and tribal government teams, please see the FRS API Account (NAAS) Setup Information to request an account. The FRS team can help guide you through determining which API (Query or Submit) you need, the process of getting a NAAS account, and configuring FRS for your account for testing.
For the Submit API, after creating a NAAS account the FRS team will help in validating your developer's approach in the pre-production Submit API and then give access to the production Submit API.
For an example of connecting to the FRS API, see this 2023 open source Python FRS API client.
Note - duplicated FRS API documentation is on the Exchange Network at the Environmental Information Exchange Network documentation of FRS API page.
API Release Notes
Active
- Version 1.07.00