Overview

In addition to being published and available at Acquisition Gateway, the listings are not available via Public APIs, yet.

Please note that the API v4.0 is available, now.

The URL for the API is https://api.gsa.gov/acquisitiongateway/api/v4.0/, and it exposes routes per content types (workgroup) to query data:

• /documents/ (TBD)

Note: No API is available at this time.

Back to top

Getting Started

To begin using this API, you will need to register for an API Key. You can sign up for an API key below. After registration, you will need to provide this API key in the x-api-key HTTP header with every API request.

Back to top

OpenAPI Specification File

You can view the full details of this API in the OpenAPI Specification file available here: Open API specification file for the Listings API

Back to top

The Response

The response represents the rows in the data array in the JSON reports that can be downloaded.

They are returned as an array of JSON objects. Here is an example of one such object:

TBD

Note that it has the following properties:

• pid: The primary key of the data point
• title: The name of the listing
• description: The description of the listing
• summary: The summary of the listing description
• type: The type of listing content

Querying Listings - API Calls

Listings can be queried…

Filtering/Sorting listings by parameters

Listings can be queried by filtering/sorting ?filter[key]=value&sorted

Ex. /documents?filter[pid]=4138

It will return document id 4138. In this case, it is also equivalent to /documents/resource/4138

HTTP Response Codes

The API will return one of the following responses:

Back to top

Contact Us

To suggest a feature or ask for help, please file an issue in our project repository.

Back to top