API Endpoints

This page is intended for users who are already familiar with APIs. If you're not sure what endpoint means, and the difference between XML, CSV and JSON, you may find the introductory tutorial more useful to start.

Endpoints do not currently require any authorization. Result data is encoded as iso-8859-1 (or ansi for Windows platform users).

Status Codes

In general, status codes returned are as follows:

• 200 if the request is successful
• 400 if the request is malformed
• 500 for server-side errors

API Throttle Limits

In order to provide a high quality of service to all users, there are throttle limits applied to the usage of the API. The API supports 5 requests every 10 seconds. All endpoints within an API share the same limits.

You will receive the following error when the throttle limit is exceeded:

Error Code: 429

Description: Request rate too high

The API limit is enforced within a rolling 10 second window. If you exceeded your limit then you will be blocked from making further API calls until the current 10 second window expires. Due to the fact that this rolling window is not tied to any standard time, the best way to ensure you will not trigger the limit is to place appropriate delays between each API call.

Endpoints and Methods

The currently available endpoints are listed in the following table. All endpoint URLs are accessible via the prefix https://efile.fara.gov. Example endpoint URL: https://efile.fara.gov/api/v1/Registrants/html/Active

Endpoint Index