@datafire/gsa_gov
Client library for Discovery Market Research
Installation and Usage
npm install --save @datafire/gsa_gov
let gsa_gov = require('@datafire/gsa_gov').create();
.then(data => {
console.log(data);
});
Description
This API drives the Discovery Market Research Tool. It contains information on the vendors that are part of the OASIS and OASIS Small Business contracting vehicles, such as their contracting history, their elligibility for contract awards, and their small business designations. To learn more about the tool, please visit Discovery or see the README on our GitHub repository.
Please note that the base path for this API is https://api.data.gov/gsa/discovery/
It requires an API key, obtainable at api.data.gov.
It must be passed in the api_key
parameter with each request.
Actions
List_Contracts_GET
This endpoint returns contract history from FPDS for a specific vendor. The vendor's DUNS number is a required parameter. You can also filter contracts by their NAICS code to find contracts relevant to a particular category.
gsa_gov.List_Contracts_GET({
"duns": ""
}, context)
Input
- input
object
- duns required
string
: A 9-digit DUNS number that uniquely identifies a vendor (required). - naics
string
: a six digit NAICS code used to filter by contracts with a certain NAICS - sort
string
: a field to sort on. Choices are date, status, agency, and amount - direction
string
: The sort direction of the results. Choices are asc or desc. - page
string
: the page to start on. Results are paginated in increments of 100. Begins at page=1.
- duns required
Output
- output
object
Metadata_GET
This endpoint returns metadata for the most recent data loads of SAM and FPDS data. It takes no parameters.
gsa_gov.Metadata_GET(null, context)
Input
This action has no parameters
Output
- output
object
List_Naics_GET
This endpoint lists all of the NAICS codes that are relevant to the OASIS family of vehicles. It takes no parameters.
gsa_gov.List_Naics_GET(null, context)
Input
This action has no parameters
Output
- output
object
Get_Vendor_GET
This endpoint returns a single vendor by their 9 digit DUNS number. DUNS numbers can be looked up in the System for Award Management by vendor name.
gsa_gov.Get_Vendor_GET({
"duns": ""
}, context)
Input
- input
object
- duns required
string
: a nine digit DUNS number that uniquely identifies the vendor (required)
- duns required
Output
- output
object
List_Vendors_GET
This endpoint returns a list of vendors filtered by a NAICS code. The NAICS code maps to an OASIS pool and is used to retrieve vendors in that pool only.
OASIS pools are groupings of NAICS codes that have the same small business size standard. Because contracts solicited to OASIS vendors can only be issued to one pool, much of the data is presented as part of a pool grouping. Using the NAICS code is a shortcut, so that you don't have to explicitly map the NAICS code to a pool in OASIS yourself.
Vendors can also be filtered by a particular setaside. Valid values for the setasides are two-character codes which include:
- A6 (8(a))
- XX (Hubzone)
- QF (service disabled veteran owned)
- A2 (women owned)
- A5 (veteran owned)
- 27 (small disadvantaged business).
gsa_gov.List_Vendors_GET({
"naics": ""
}, context)
Input
- input
object
- naics required
string
: a six digit NAICS code (required) - setasides
array
: a comma delimited list of two character setaside codes to filter by. Ex. setasides=A6,A5 will filter by 8a and veteran owned business. - vehicle
string
: Choices are either oasis or oasissb. Will filter vendors by their presence in either the OASIS unrestricted vehicle or the OASIS Small Business vehicle.
- naics required
Output
- output
object
Definitions
This integration has no definitions