Skip to content

API Reference

The API is a JSON REST API served under /api/v1 (/api/v2/<path> is an alias of the same routes). Its OpenAPI schema is generated from the code, not hand-written here, so it matches what the API accepts and returns.

The interactive Swagger page and the schema file are switched off on the production service. If you are building an integration and need the schema for the routes you use, ask support from inside the application.

  • Authentication: bearer tokens for the signed-in API, and API keys for the public API.
  • Errors: the status codes and the shapes of error bodies.
  • Rate Limits: the limits and the Retry-After header.

An API key created in the application gives read access to the public API: contract search (GET /api/v1/public/v1/contracts/search, with q, naics, agency and limit), contract detail, and webhook registration. It returns the contract data the platform holds. See Data Sources for what that is.

Two routes back the notification settings in the app:

  • GET /api/v1/notifications lists a person’s notifications. Pass group=search to fold saved-search matches into one group per search.
  • GET and PUT /api/v1/notifications/preferences read and save a person’s notification preferences. The save replaces the whole body. An unknown kind or an out-of-range value answers 422 and changes nothing.

Try this in the platform