### TMSS 2.0 HHG Rate Query API - Getting Started Source: https://open.gsa.gov/api/ratequeryhhg Instructions on how to get started with the TMSS 2.0 HHG Rate Query API, including obtaining an API key and an agency token. ```APIDOC ## 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. Please enable JavaScript to signup for an api.data.gov API key. • After registering for the API Key, you will need to send an email to errc@gsa.gov requesting the Agency Token (x-agency-token). You must also attach to that email a completed copy of the Memorandum Of Understanding (MOU). Click here to download the MOU template. ``` -------------------------------- ### Get IVL Response Example (JSON) Source: https://open.gsa.gov/api/opportunities-api This JSON snippet demonstrates the structure of a response when retrieving the Interested Vendor List (IVL) for a given opportunity ID. It includes details about vendors, their contact information, addresses, and NAICS codes. This example is applicable to both v1 and v2 of the API, with minor differences in identifier fields. ```json { "ivl": [ { "cageNumber": "3ABC1", "name": "TECH SYSTEMS, INC.", "addedOn": "2019-03-04 15:06:11", "contacts": [ { "email": "johndoe@techsystems.com", "firstName": "JOHN", "lastName": "DOE", "phoneNumber": "7031234567", "type": "Government Business POC" } ], "addresses": [ { "streetAddress": "P.O. BOX 123", "city": "SOMECITY", "state": "VIRGINIA", "zip": "22102", "country": "UNITED STATES", "addressType": "mailing" } ], "naicsList": [ "423430", "511210", "518210", "541330", "541511", "541512", "541513", "541519", "541611", "541618", "541990", "611430", "811212" ] } ], "page": { "size": 10, "totalElements": 1, "totalPages": 1, "number": 0 } } ``` ```json { "ivl": [ { "ueiSAM": "025114695AST", "cageNumber": "3ABC1", "name": "TECH SYSTEMS, INC.", "addedOn": "2019-03-04 15:06:11", "contacts": [ { "email": "johndoe@techsystems.com", "firstName": "JOHN", "lastName": "DOE", "phoneNumber": "7031234567", "type": "Government Business POC" } ], "addresses": [ { "streetAddress": "P.O. BOX 123", "city": "SOMECITY", "state": "VIRGINIA", "zip": "22102", "country": "UNITED STATES", "addressType": "mailing" } ], "naicsList": [ "423430", "511210", "518210", "541330", "541511", "541512", "541513", "541519", "541611", "541618", "541990", "611430", "811212" ] } ], "page": { "size": 10, "totalElements": 1, "totalPages": 1, "number": 0 } } ``` -------------------------------- ### Example Opportunity History Response (JSON) Source: https://open.gsa.gov/api/opportunities-api This is an example of the JSON response structure returned by the 'Get Opportunity History' endpoint. It includes details about various historical actions performed on the opportunity, such as publishing, cancellation, and archiving, along with associated dates and identifiers. ```JSON { "content": { "history": [ { "parentOpportunityId": "66544daa822c3c1667d927a70b7324f1", "cancel_notice": "0", "procurement_type": "p", "archive_notice": "0", "request_type": "submit", "action_type": "publish", "action_date": null, "index": "5", "title": "61 -- Loadbank", "relatedOpportunityId": null, "opportunityId": "9d8a8d2b0befa3b6b9683a689566d9c4", "deleted": "0", "solicitation_number": "FA8532-06-R-70739", "revision_reason": null, "posted_date": null, "latest": "1" }, { "parentOpportunityId": "66544daa822c3c1667d927a70b7324f1", "cancel_notice": "0", "procurement_type": "p", "archive_notice": "0", "request_type": "submit", "action_type": "publish", "action_date": "2006-11-01T05:00:00+00", "index": "4", "title": "61 -- Loadbank", "relatedOpportunityId": null, "opportunityId": "1ef3f05d226c7cf877de3bcc285621aa", "deleted": "0", "solicitation_number": "FA8532-06-R-70739", "revision_reason": null, "posted_date": "2006-11-01T00:00:00", "latest": "0" } ] } } ``` -------------------------------- ### Get All Entities as JSON via POST (API) Source: https://open.gsa.gov/api/entity-api This example shows how to initiate a POST request to retrieve a JSON file of all entities. The request specifies the desired format as JSON and provides URLs for both production and alpha environments for v2 and v3 APIs. The response includes a token for downloading the generated file. ```api POST https://api.sam.gov/entity-information/v2/entities?format=JSON ``` ```api POST https://api.sam.gov/entity-information/v3/entities?format=JSON ``` -------------------------------- ### PRESOL Request Example Source: https://open.gsa.gov/api/opportunities-api Example of a request body for a presolicitation notice. ```APIDOC ## POST /create (PRESOL Request Example) ### Description Example of a request body for creating a presolicitation notice. ### Request Body Example ```json { "data": { "solicitationNumber": "PRESOLTest1", "title": "PRESOLTEST_T1", "type": "p", "classificationCode": "13", "organizationId": "100186612", "naics": [{ "type": "primary", "code": ["111150"] }], "pointOfContact": [{ "additionalInfo": { "content": "" }, "email": "testemail@gsa.gov", "fax": "", "fullName": "test user", "phone": "", "title": "", "type": "primary" }], "placeOfPerformance": { "city": { "code": "", "name": "" }, "country": { "code": "", "name": "" }, "state": { "code": "", "name": "" }, "streetAddress": "", "streetAddress2": "", "zip": "" }, "permissions": { "IVL": { "create": false, "delete": false, "read": false, "update": false } }, "solicitation": { "setAside": "SBA", "deadlines": { "response": "2020-02-25T11:00:00-04:00", "responseTz": "America/New_York" } }, "archive": { "type": "autocustom", "date": "2023-09-09" }, "additionalReporting": [ "none" ] }, "description": [{ "body": "Description" }] } ``` ``` -------------------------------- ### COMBINE Request Example Source: https://open.gsa.gov/api/opportunities-api Example of a request body for combining opportunity information. ```APIDOC ## POST /create (COMBINE Request Example) ### Description Example of a request body for combining opportunity information. ### Request Body Example ```json { "data": { "solicitationNumber": "Test1combine1", "title": "TST_T1", "type": "k", "classificationCode": "13", "organizationId": "100186612", "archive": { "type": "autocustom", "date": "2022-09-09" }, "naics": [ { "type": "primary", "code": [ "111150" ] } ], "pointOfContact": [ { "additionalInfo": { "content": "" }, "email": "testemail@gsa.gov", "fax": "", "fullName": "test user", "phone": "", "title": "", "type": "primary" } ], "permissions": { "IVL": { "create": false, "delete": false, "read": false, "update": false } }, "solicitation": { "setAside": "", "deadlines": { "responseTz": "America/New_York", "response": "2022-11-11T11:12:00-05:00" } }, "additionalReporting": [ "none" ] } } ``` ``` -------------------------------- ### USPS Lookup API Example Source: https://open.gsa.gov/api/ratequeryhhg This example demonstrates how to call the USPS Lookup API using a GET request. The API is used to find city names or zip codes. You must include the API-KEY in the 'x-api-key' header. The query parameter 'cityName=' is used to pass the search term, which can be a city name or a zip code, or partial matches thereof. ```http GET https://api.gsa.gov/travel/tmss/v1/uspslookup/?cityName=Alexandria Header: x-api-key: YOUR_API_KEY ``` -------------------------------- ### Get Detailed Information for a Single Docket Source: https://open.gsa.gov/api/regulationsgov This example retrieves detailed information for a specific docket identified by its `docketId`. The query directly targets the docket's endpoint and requires an API key. ```http https://api.regulations.gov/v4/dockets/EPA-HQ-OAR-2003-0129?api_key=DEMO_KEY ``` -------------------------------- ### Get Service Contracts in Virginia (FY25, Small Business) Source: https://open.gsa.gov/api/contract-awards This example demonstrates how to construct a request URL for the SAM.gov API to retrieve service contracts performed in Virginia during Fiscal Year 2025. It filters results to include only those from small businesses and specifies the desired output sections: contract ID, award details, and awardee data. The API key needs to be replaced with a valid one. The response is expected in JSON format. ```HTTP GET https://api.sam.gov/contract-awards/v1/search?api_key=< API Key >&coBusSizeDeterminationCode=S&placeOfPerformStateCode=VA&fiscalYear=2025&productOrServiceType=SERVICE&includeSections=contractId,awardDetails,awardeeData ``` -------------------------------- ### Multiple Suggestions API Example Source: https://open.gsa.gov/api/dx-calc-api This example demonstrates how to combine multiple 'suggest' parameters in a single API request to retrieve suggestions for different fields simultaneously. This allows for more targeted data retrieval. ```URL https://api.gsa.gov/acquisition/calc/v3/api/ceilingrates/?suggest=labor_category:co&suggest=vendor_name:te&suggest=idv_piid:47q ``` -------------------------------- ### Paginated GET Contract Reports (GET) API Response Source: https://open.gsa.gov/api/subawards-bulkupload-api Shows an example of a paginated GET request for subcontract reports associated with a contract. The response structure includes a list of reports, indicating pagination is applied. This example uses a Contract ID (PIID) in query parameters. ```json { "responseList":[ ``` -------------------------------- ### Default API Request Example Source: https://open.gsa.gov/api/dx-calc-api This example demonstrates a default API request with pagination, sorting, and filtering parameters. It is used to provide a sensible default experience when initially loading the application. The API supports filtering by experience and price ranges. ```URL https://api.gsa.gov/acquisition/calc/v3/api/ceilingrates/?" page=1 &page_size=20 &ordering=current_price &sort=asc &filter=experience_range:0,45 &filter=price_range:15,500 ``` -------------------------------- ### Get Opportunity by ID Response Example (JSON - v2) Source: https://open.gsa.gov/api/opportunities-api This JSON structure shows an example response for the Get Opportunity by ID endpoint, specifically for version 2 of the API. It includes key details such as award information, NAICS codes, solicitation title, and points of contact. ```json { "data": { "type": "i", "award": { "date": "2022-07-12", "number": "test_award_123", "lineItemNumber": null }, "naics": [ { "code": [ "111130" ], "type": "primary" } ], "title": "Test_notice", "archive": { "date": "2022-12-18", "type": "auto30" }, "version": "2", "farCases": [ "FAR 7.107-2", "FAR 7.107-4" ], "permissions": { "IVL": { "read": true, "create": true, "delete": true, "update": true } }, "solicitation": { "deadlines": { "response": null, "responseTz": null } }, "pointOfContact": [ { "fax": "", "type": "primary", "email": "test@gsa.gov", "phone": "", "title": null, "fullName": "John Smith" } ], "classificationCode": "1015", "solicitationNumber": "Test12345" } } ``` -------------------------------- ### Suggest API Example (Legacy) Source: https://open.gsa.gov/api/dx-calc-api These examples show how to use the legacy 'suggest' parameter to retrieve specific values from the CEILINGRATES data set, useful for populating search fields. Note that the 'suggest' parameter may be deprecated or have limitations. ```URL https://api.gsa.gov/acquisition/calc/v3/api/ceilingrates/?suggest=labor_category:co ``` ```URL https://api.gsa.gov/acquisition/calc/v3/api/ceilingrates/?suggest=vendor_name:te ``` ```URL https://api.gsa.gov/acquisition/calc/v3/api/ceilingrates/?suggest=idv_piid:47q ``` -------------------------------- ### GET /action/status_show Source: https://open.gsa.gov/api/datadotgov/v1/openapi Fetches the current status of the Data.gov site, including version information and installed extensions. ```APIDOC ## GET /action/status_show ### Description Returns the site status. ### Method GET ### Endpoint /action/status_show ### Request Example ```json { "example": "GET /action/status_show" } ``` ### Response #### Success Response (200) - **result** (object) - Contains the site status information. - **status** (string) - The current status of the site. - **version** (string) - The version of the CKAN software. - **extensions** (array) - A list of installed extensions. #### Response Example ```json { "help": "https://catalog.data.gov/api/3/action/help_show?name=status_show", "success": true, "result": { "status": "OK", "version": "2.9.2", "extensions": [ "ckanext-ytp", "ckanext-qa" ] } } ``` ``` -------------------------------- ### Suggest Contains Search Source: https://open.gsa.gov/api/dx-calc-api Search for ceiling rates using partial matches on labor category, vendor name, or contract numbers. ```APIDOC ## GET /acquisition/calc/v3/api/ceilingrates/ ### Description Searches for ceiling rates with partial matches on specified fields. ### Method GET ### Endpoint /acquisition/calc/v3/api/ceilingrates/ ### Query Parameters - **suggest-contains** (string) - Required - A parameter to perform a partial match search. Examples: `labor_category:chief`, `vendor_name:adv`, `idv_piid:012` - **page** (integer) - Optional - The page number for paginated results. Default is 1. - **page_size** (integer) - Optional - The number of results per page. Default is 100. ``` -------------------------------- ### GET Request for Published Subaward Report - JSON Example Source: https://open.gsa.gov/api/subawards-bulkupload-api This JSON response illustrates a successful GET request for a specific subaward report that has been published. It includes transaction details, report status, and the associated assistance data, highlighting the structure of a retrieved report. ```json [ { "id": "fain:subawardNumber:subawardDate:subawardAmount:submittedDate", "statusCode":"200", "transactionId":"58e2fad8-7b43-4b62-a870-45b3f250ea72", "timeStamp":"2024-02-20T19:51:24.915924", "subawardReportNumber":"71e2fad8-7b43-4b62-a870-45b3f250ea98", "reportStatus":"Published", "message":{ "assistanceData":[ { "fain":"string", "agencyCode":"string", "subawardDataList":[ { "subawardReportNumber":"71e2fad8-7b43-4b62-a870-45b3f250ea98", "submittedDate":"2024-02-12", "subawardUEI":"string", "subawardNumber":"string", "subawardAmount":"string", "subawardDate":"string", "subawardDescription":"string", "placeOfPerformance":{ "city":"string", "country":{ "code":"string", "name":"string" }, "stateOrProvince":{ "code":"string", "name":"string" }, "zip":"string", "congressional_district":"string" }, "recoveryModelQuestions":[ { "code":"1", "isSelected":false } ] } ] } ] }, "errors":[] } ] ``` -------------------------------- ### System Account Creation and API Key Retrieval Source: https://open.gsa.gov/api/entity-api Information on how to create a system account, set a password, and retrieve an API key for accessing SAM.gov data. Includes criteria for system accounts and available data permissions. ```APIDOC ## System Accounts and API Key Retrieval ### Description This section outlines the process for non-federal and federal users to obtain a System Account on SAM.gov. It details the steps for creating the account, setting a password, and retrieving an API Key. It also specifies the criteria a System Account must meet to use the Entity Management API, including required permissions and security information. ### System Account Criteria #### Permissions * **read public**: Grants access to public data. * **read public, read fouo**: Grants access to public and FOUO (CUI) data. * **read public, read fouo, read sensitive**: Grants access to public, FOUO (CUI), and Sensitive (CUI) data. #### Security Information * **IP Address**: A list of all IP addresses from which the System invokes the API. * **Type of Connection**: REST APIs ### API Key Rate Limits | Type of User Account | Type of API Key | Default API Daily Rate Limit | | :-------------------------- | :----------------------- | :--------------------------- | | Non-federal user with no Role | Personal API key | 10 requests/day | | Non-federal user with a Role | Personal API key | 1,000 requests/day | | Federal User | Personal API key | 1,000 requests/day | | Non-federal System user | System account API key | 1,000 requests/day | | Federal System user | System account API key | 10,000 requests/day | ### Sensitive API Process * **Authentication**: System Account User ID and Password must be sent as "Basic Auth" in the "Authorization" Header (base64 encoded: base64(username:password)). * **API Key**: The API Key value must be sent as "x-api-key" in the Headers, not in the request URL. * **Headers**: * `Accept`: `application/json` * `Content-Type`: `application/json` * **Search Filters**: Optional search filters can be sent in the request URL or in the Body. ### Request Example (cURL) **Using Basic Auth Token:** ```bash curl -X POST "https://api.sam.gov/entity-information/v2/entities?ueiSAM=< UEI >" \ --header "X-Api-Key: < a valid API Key >" \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Basic < auth token >" ``` **Using Username and Password:** ```bash curl -X POST "https://api.sam.gov/entity-information/v2/entities?ueiSAM=< UEI >" \ --header "X-Api-Key: < a valid API Key >" \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --user "< username >:< password >" ``` ### Utilizing the API Extract (CSV/JSON) * **Format**: * `format=csv` for CSV data. * `format=json` for JSON data. * **Download URL**: A file downloadable URL with a token will be returned upon successful execution. This URL can also be obtained via email by providing `emailId=Yes` in the request. * **API Key Replacement**: In the file downloadable URL, `REPLACE_WITH_API_KEY` must be replaced with a valid API Key. * **File Availability**: If the file is ready for download, it can be retrieved. Otherwise, users will need to try again later. ``` -------------------------------- ### Create SOL Opportunity JSON Example (OpenGSA API) Source: https://open.gsa.gov/api/opportunities-api This JSON payload demonstrates how to create and publish a new 'SOLICITATION' opportunity, including details like title, organization, NAICS codes, points of contact, place of performance, and attachments. ```json { "data": { "type": "o", "solicitationNumber": "test-12345457", "title": "Test Create and Publish SOL notice", "organizationId": "100186612", "classificationCode": "1260", "naics": [ { "type": "primary", "code": [ "111150" ] } ], "pointOfContact": [ { "type": "primary", "title": "", "fullName": "test contact", "email": "test@test.com", "phone": "", "fax": "", "additionalInfo": { "content": "Primary contact info" } } ], "placeOfPerformance": { "streetAddress": "1234 XYZ street", "streetAddress2": "", "city": { "code": "75376", "name": "Sterling" }, "state": { "code": "VA", "name": "Virginia" }, "country": { "code": "USA", "name": "USA" }, "zip": "" }, "archive": { "type": "autocustom", "date": "2022-09-09" }, "permissions": { "IVL": { "create": false, "delete": false, "read": false, "update": false } }, "solicitation": { "setAside": "SBA", "deadlines": { "response": "2020-02-25T11:00:00-06:00", "responseTz": "America/Chicago" } }, "additionalReporting": [ "none" ] }, "description": [ { "body": "test description" } ], "related": { "opportunityId": "f8ccfca94d794e07855ebe0d6f55c7d5" }, "resources": [ { "attType": "link", "link": "https://faaco.faa.gov/index.cfm/attachment/download/84723", "description": "test attachment pdf link" }, { "attType": "file", "content": "SGVsbG8=", "resourceName": "Hello.txt", "fileType": "text/plain", "packageAccessLevel": "private", "explicitAccess": "1" } ] } ``` -------------------------------- ### Get Subcontract Report - REST API Example Source: https://open.gsa.gov/api/subawards-bulkupload-api Demonstrates a GET request to retrieve a specific subcontract report with a 'Published' status. This endpoint is useful for accessing detailed financial and performance data related to subcontracts. The response includes transaction details, report status, and nested contract and subaward data. ```curl curl -X GET "https://api.example.com/contracts/subaward/report?status=Published" -H "accept: application/json" ``` -------------------------------- ### Paginated GET Request for Assistance Award Subaward Reports Source: https://open.gsa.gov/api/subawards-bulkupload-api Example response for a paginated GET request for subaward reports associated with an assistance award. The request includes an Award ID (FAIN) in query parameters and returns a list of reports across multiple pages. This snippet shows the structure of the response, including a list of reports and pagination metadata. ```json { "responseList":[ { "id": "fain:subawardNumber:subawardDate:subawardAmount:submittedDate", "statusCode":"200", "transactionId":"48e2fad8-7b43-4b62-a870-45b3f250ea72", "timeStamp":"2024-02-20T19:51:24.915924", "reportStatus":"Published", "message":{ "assistanceData":[ { "fain":"string", "agencyCode":"string" } ] } } ] } ``` -------------------------------- ### Get Opportunity by ID Response Example (JSON) Source: https://open.gsa.gov/api/opportunities-api This JSON object represents a successful response when retrieving an opportunity by its ID. It contains detailed information about the opportunity, including links, classification, dates, and organizational details. The structure is consistent across different versions of the API. ```json { "data": { "link": { "href": "https://www.fedconnect.net/FedConnect/?doc=140S0318B0003&agency=DOI ", "additionalInfo": { "content": "Click here to see more information about this opportunity on FedConnect" } }, "type": "s", "flags": [ { "code": "isScheduledNotice", "isSelected": false } ], "naics": [ { "code": [ "312111" ] } ], "title": "XYZ--CONSTRUCTION", "archive": { "date": "2020-01-16", "type": "auto15" }, "permissions": { "IVL": { "read": false, "create": true, "delete": true, "update": true } }, "solicitation": { "deadlines": { "response": "2020-01-01T23:59:00-05:00", "responseTz": "America/New_York" } }, "organizationInfo": [ { "name": "General Services Administration", "code": "047", "orgKey": "100006688" } ] "classificationCode": "9999", "solicitationNumber": "140S0318B0003", "additionalReporting": [ "none" ] }, "additionalInfo": { "sections": [ { "id": "header", "status": "updated" }, { "id": "award", "status": "updated" }, { "id": "general", "status": "updated" }, { "id": "classification", "status": "updated" }, { "id": "description", "status": "updated" }, { "id": "attachments-links", "status": "updated" }, { "id": "contact", "status": "updated" } ] }, "parent": { "opportunityId": "f4685436437d1846830932117ecad067" }, "related": { }, "status": { "code": "published", "value": "Published" }, "archived": false, "cancelled": false, "latest": true, "deleted": false, "postedDate": "2019-02-19T16:34:32.267+0000", "modifiedDate": "2019-02-19T16:34:32.267+0000", "createdDate": "2019-02-19T16:33:17.126+0000", "modifiedBy": "reitestuser+aa@gsa.gov", "createdBy": "reitestuser+aa@gsa.gov", "description": [ { "opportunityId": "bac24bfdc52046ae90ff0ddfe818bfd4", "descriptionId": "759877f6e64d423cbf23997006ea767a", "modifiedOn": "2019-02-19T16:34:32.265+0000", "body": "The Department of the Interior's Office of Surface Mining Reclamation and Enforcement intends to release" } ], "opportunityId": "bac24bfdc52046ae90ff0ddfe818bfd4" } ``` -------------------------------- ### Search Opportunities API v2 Request Source: https://open.gsa.gov/api/get-opportunities-public-api This example shows how to construct a request URL to search for opportunities using the v2 endpoint of the OpenGSA Gov API. It includes parameters for filtering by date, title, and setting a limit, as well as requiring an API key. The alpha and production URLs are provided for different environments. ```URL https://api.sam.gov/opportunities/v2/search?limit=10&api_key={User’s Public API Key}&postedFrom=01/01/2018&postedTo=05/10/2018&title=Driving https://api-alpha.sam.gov/opportunities/v2/search?limit=10&api_key={User’s Public API Key}&postedFrom=01/01/2020&postedTo=05/10/2020 ``` -------------------------------- ### GET /contract-awards/v1/search Source: https://open.gsa.gov/api/contract-awards This endpoint allows you to search for contract awards. You can filter by deleted status, modification dates, and specify which sections of the contract award to include in the response. This example specifically shows how to retrieve deleted contracts modified between two dates and only return the contract ID. ```APIDOC ## GET /contract-awards/v1/search ### Description Retrieves a list of contract awards, with options to filter by deleted status, modification dates, and requested data sections. The example demonstrates fetching deleted contracts modified within a specific date range and returning only the contract ID. ### Method GET ### Endpoint `/contract-awards/v1/search` ### Parameters #### Query Parameters - **api_key** (string) - Required - Your API key for authentication. - **deletedStatus** (string) - Optional - Set to `yes` to retrieve deleted contracts. - **lastModifiedDate** (string) - Optional - Specifies the date range for contract modifications. Format: `[MM/DD/YYYY,MM/DD/YYYY]`. - **includeSections** (string) - Optional - Comma-separated list of sections to include in the response. For example, `contractId`. ### Request Example ```bash GET https://api.sam.gov/contract-awards/v1/search?api_key=< API Key >&deletedStatus=yes&lastModifiedDate=[10/01/2025,10/02/2025]&includeSections=contractId ``` ### Response #### Success Response (200) - **awardSummary** (array) - An array of contract award summaries. - **contractId** (object) - Contains details about the contract ID. - **subtier** (object) - Information about the subtier agency. - **code** (string) - The subtier agency code. - **name** (string) - The subtier agency name. - **piid** (string) - The Procurement Instrument Identifier. - **modificationNumber** (string) - The modification number of the contract. - **transactionNumber** (string) - The transaction number. - **referencedIDVSubtier** (object) - Information about the referenced IDV subtier agency (if applicable). - **referencedIDVPiid** (string) - The PIID of the referenced IDV. - **referencedIDVModificationNumber** (string) - The modification number of the referenced IDV. - **reasonForModification** (object) - The reason for the contract modification (if applicable). - **totalRecords** (string) - The total number of records found. - **limit** (string) - The limit set for the number of records returned per page. - **offset** (string) - The offset value for pagination. #### Response Example ```json { "awardSummary": [ { "contractId": { "subtier": { "code": "3600", "name": "VETERANS AFFAIRS, DEPARTMENT OF" }, "piid": "VA25715J1359", "modificationNumber": "0", "transactionNumber": "0", "referencedIDVSubtier": { "code": "3600", "name": "VETERANS AFFAIRS, DEPARTMENT OF" }, "referencedIDVPiid": "V797P3148M", "referencedIDVModificationNumber": "P00013" } } ], "totalRecords": "162", "limit": "5", "offset": "25" } ``` ``` -------------------------------- ### GET /opportunities/v2/search Source: https://open.gsa.gov/api/get-opportunities-public-api This endpoint allows you to search for government contracting opportunities. You can filter results by date posted, opportunity type, department name, and more. The example below demonstrates a search for award notices posted between January 1, 2018, and May 10, 2018, from the General Services Administration. ```APIDOC ## GET /opportunities/v2/search ### Description Searches for government contracting opportunities with various filtering parameters. ### Method GET ### Endpoint https://api.sam.gov/prod/opportunities/v2/search ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of results to return. - **api_key** (string) - Required - Your public API key. - **postedFrom** (string) - Optional - The start date for posting (MM/DD/YYYY). - **postedTo** (string) - Optional - The end date for posting (MM/DD/YYYY). - **ptype** (string) - Optional - The type of opportunity (e.g., 'a' for Award Notice). - **deptname** (string) - Optional - The name of the department to filter by. ### Request Example ``` GET https://api-alpha.sam.gov/prodlike/opportunities/v2/search?limit=1&api_key={User’s Public API Key}&postedFrom=01/01/2018&postedTo=05/10/2018&ptype=a&deptname=general ``` ### Response #### Success Response (200) - **totalRecords** (integer) - The total number of records found. - **limit** (integer) - The limit applied to the number of results. - **offset** (integer) - The offset for pagination. - **opportunitiesData** (array) - An array of opportunity objects. - **noticeId** (string) - Unique identifier for the notice. - **title** (string) - Title of the opportunity. - **solicitationNumber** (string) - Solicitation number. - **department** (string) - Department posting the opportunity. - **subTier** (string) - Sub-tier of the department. - **office** (string) - Office posting the opportunity. - **postedDate** (string) - Date the opportunity was posted. - **type** (string) - Type of notice (e.g., "Award Notice"). - **baseType** (string) - Base type of the notice. - **archiveType** (string) - Type of archive. - **archiveDate** (string) - Date of archive. - **typeOfSetAsideDescription** (string) - Description of set-aside type. - **typeOfSetAside** (string) - Type of set-aside. - **responseDeadLine** (string) - Deadline for response. - **naicsCode** (string) - NAICS code. - **classificationCode** (string) - Classification code. - **active** (string) - Whether the notice is active. - **award** (object) - Award details (if applicable). - **date** (string) - Award date. - **number** (string) - Award number. - **amount** (string) - Award amount. - **awardee** (object) - Details about the awardee. - **name** (string) - Name of the awardee. - **location** (object) - Location of the awardee. - **streetAddress** (string) - Street address. - **city** (object) - City information. - **code** (string) - City code. - **name** (string) - City name. - **state** (object) - State information. - **code** (string) - State code. - **zip** (string) - Zip code. - **country** (object) - Country information. - **code** (string) - Country code. - **ueiSAM** (string) - UEI SAM of the awardee. - **pointOfContact** (array) - Array of points of contact. - **fax** (string) - Fax number. - **type** (string) - Type of contact. - **email** (string) - Email address. - **phone** (string) - Phone number. - **title** (string) - Title of the contact. - **fullName** (string) - Full name of the contact. - **description** (string) - Link to the full notice description. - **organizationType** (string) - Type of organization. - **officeAddress** (object) - Address of the office. - **zipcode** (string) - Zip code. - **city** (string) - City. - **countryCode** (string) - Country code. - **state** (string) - State. - **placeOfPerformance** (object) - Place of performance details. - **streetAddress** (string) - Street address. - **city** (object) - City information. - **code** (string) - City code. - **name** (string) - City name. - **state** (object) - State information. - **code** (string) - State code. - **zip** (string) - Zip code. - **country** (object) - Country information. - **code** (string) - Country code. - **additionalInfoLink** (string) - Link for additional information. - **uiLink** (string) - UI link for the opportunity. - **links** (array) - Array of links related to the notice. - **rel** (string) - Relationship of the link. - **href** (string) - URL of the link. - **hreflang** (string) - Language of the link. - **media** (string) - Media type of the link. - **title** (string) - Title of the link. - **type** (string) - Type of the link. - **deprecation** (string) - Deprecation information. #### Response Example ```json { "totalRecords": 34, "limit": 1, "offset": 0, "opportunitiesData": [ { "noticeId": "5b345bbb7127b91a3ad577b203fc6f68", "title": "Historic Office Renovation ", "solicitationNumber": " 47PF0018R0023 ", "department": "GENERAL SERVICES ADMINISTRATION", "subTier": "PUBLIC BUILDINGS SERVICE", "office": "PBS R5", "postedDate": "2018-05-04", "type": "Award Notice", "baseType": "Combined Synopsis/Solicitation", "archiveType": "manual", "archiveDate": null, "typeOfSetAsideDescription": null, "typeOfSetAside": null, "responseDeadLine": null, "naicsCode": "236220", "classificationCode": "Z", "active": "Yes", "award": { "date": "2018-05-04", "number": "47PF0018C0066", "amount": "800620", "awardee": { "name": "D.G. Beyer, Inc.", "location": { "streetAddress": "3080 S Calhoun Rd.", "city": { "code": "56375", "name": "New Berlin" }, "state": { "code": "WI" }, "zip": "53151", "country": { "code": "USA" } }, "ueiSAM": "025114695AST" } }, "pointOfContact": [ { "fax": null, "type": "primary", "email": "jesse.jones@gsa.gov", "phone": "2174941263", "title": "Contracting Officer ", "fullName": "Jesse L. Jones" } ], "description": "https://api.sam.gov/prod/opportunities/v1/noticedesc?noticeid=5b345bbb7127b91a3ad577b203fc6f68", "organizationType": "OFFICE", "officeAddress": { "zipcode": "60604", "city": "CHICAGO", "countryCode": "USA", "state": "IL" }, "placeOfPerformance": { "streetAddress": "517 E Wisconsin Ave", "city": { "code": "53000", "name": "Milwaukee" }, "state": { "code": "WI" }, "zip": "53202", "country": { "code": "USA" } }, "additionalInfoLink": null, "uiLink": "https://beta.sam.gov/opp/5b345bbb7127b91a3ad577b203fc6f68/view", "links": [ { "rel": "self", "href": "https://api.sam.gov/prod/opportunities/v1/search?noticeid=5b345bbb7127b91a3ad577b203fc6f68&limit=1", "hreflang": null, "media": null, "title": null, "type": null, "deprecation": null } ] } ], "links": [ { "rel": "self", "href": "https://api.sam.gov/prod/opportunities/v1/search?limit=1&postedFrom=01/01/2018&postedTo=05/10/2018&ptype=a&deptname=general", "hreflang": null, "media": null, "title": null, "type": null, "deprecation": null } ] } ``` ```