Tango API

https://tango.makegov.com/docs/
Admin
Tango API provides comprehensive access to federal procurement and assistance data including...
Tokens:104,002
Snippets:598
Trust Score:5.8
Update:8 months ago
Show doc for...
Tokens:
Raw
### Make First API Call to Get Agency Info (JavaScript)

Source: https://tango.makegov.com/docs/getting-started/quick-start

This JavaScript example uses the 'fetch' API to retrieve agency information. It demonstrates setting the API key in the request headers and asynchronously processing the JSON response to log the agency's name and department.

```javascript
const response = await fetch('https://tango.makegov.com/api/agencies/7200/', {
  headers: {
    'X-API-KEY': 'your-api-key-here'
  }
});

const agency = await response.json();
console.log(`Agency: ${agency.name}`);
console.log(`Department: ${agency.department.name}`);
```

--------------------------------

### Make First API Call to Get Agency Info (Python)

Source: https://tango.makegov.com/docs/getting-started/quick-start

This Python snippet shows how to fetch agency details using the 'requests' library. It includes setting the API key in the headers and parsing the JSON response to display the agency's name and department.

```python
import requests

headers = {'X-API-KEY': 'your-api-key-here'}
response = requests.get(
    'https://tango.makegov.com/api/agencies/7200/',
    headers=headers
)

agency = response.json()
print(f"Agency: {agency['name']}")
print(f"Department: {agency['department']['name']}")
```

--------------------------------

### Subscription Examples

Source: https://tango.makegov.com/docs/webhooks-user-guide

Provides example subscription payloads for common use cases, such as subscribing to new awards from specific agencies or for particular entities.

```APIDOC
## Subscription Examples

These are copy/paste subscription payloads for common use cases.
Notes:
  * Replace placeholder IDs like `<UEI>` / `<ORG_FH_KEY>` / `<OPPORTUNITY_UUID>` with real values.
  * For agency-based filters, we recommend using the **Organization`fh_key` /`l2_fh_key`** (stable). You can look this up via `/api/organizations/` (search by agency name/acronym).

### Subscribe to new awards funded by the VA

```json
{
  "subscription_name": "New awards funded by the VA",
  "payload": {
    "records": [
      {
        "event_type": "awards.new_award",
        "subject_type": "funding_agency",
        "subject_ids": ["<VA_ORG_FH_KEY>"]
      }
    ]
  }
}
```

### Subscribe to new awards for Oshkosh

```json
{
  "subscription_name": "New awards for Oshkosh (by UEI)",
  "payload": {
    "records": [
      {
        "event_type": "awards.new_award",
        "subject_type": "entity",
        "subject_ids": ["<OSHKOSH_UEI>"]
      }
    ]
  }
}
```

### Subscribe to new opportunities out of CMS

```json
{
  "subscription_name": "New opportunities from CMS",
  "payload": {
    "records": [
      {
        "event_type": "opportunities.new_opportunity",
        "subject_type": "agency",
        "subject_ids": ["<CMS_ORG_FH_KEY>"]
      }
    ]
  }
}
```
```

--------------------------------

### List OTIDVs with Search and Ordering (Node.js)

Source: https://tango.makegov.com/docs/api-reference/otidvs

This Node.js snippet illustrates how to list OTIDVs using the tango-node SDK. It covers client initialization with an API key and making a GET request to the /api/otidvs/ endpoint with search, ordering, and limit parameters. The example logs the count of the returned data.

```javascript
import { TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });
const http = (client as any).http;

const data = await http.get("/api/otidvs/", {
  search: "DARPA",
  ordering: "-award_date",
  limit: 10,
});

console.log("count:", data.count);

```

--------------------------------

### Make First API Call to Get Agency Info (cURL)

Source: https://tango.makegov.com/docs/getting-started/quick-start

This snippet demonstrates how to make a basic GET request to retrieve information about a specific government agency using cURL. It requires an API key for authentication and specifies the agency ID in the URL.

```shell
curl -H "X-API-KEY: your-api-key-here" \ 
  "https://tango.makegov.com/api/agencies/7200/"
```

--------------------------------

### Get Agency Information

Source: https://tango.makegov.com/docs/getting-started/quick-start

Retrieve details about a specific government agency using its unique code.

```APIDOC
## GET /api/agencies/{agency_code}/

### Description
Retrieves detailed information about a specific government agency.

### Method
GET

### Endpoint
/api/agencies/{agency_code}/

### Parameters
#### Path Parameters
- **agency_code** (string) - Required - The unique identifier for the agency.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -H "X-API-KEY: your-api-key-here" \
  "https://tango.makegov.com/api/agencies/7200/"
```

### Response
#### Success Response (200)
- **code** (string) - The agency's code.
- **name** (string) - The full name of the agency.
- **department** (object) - Information about the department the agency belongs to.
  - **code** (string) - The department's code.
  - **name** (string) - The name of the department.
- **abbreviation** (string) - The agency's abbreviation.
- **website** (string) - The agency's official website URL.

#### Response Example
```json
{
  "code": "7200",
  "name": "Department of Veterans Affairs",
  "department": {
    "code": "36",
    "name": "Department of Veterans Affairs"
  },
  "abbreviation": "VA",
  "website": "https://www.va.gov"
}
```
```

--------------------------------

### List OTIDVs with Search and Ordering (Python)

Source: https://tango.makegov.com/docs/api-reference/otidvs

This Python snippet demonstrates how to list OTIDVs using the tango-python SDK. It shows how to authenticate, make a GET request to the /api/otidvs/ endpoint, and apply search and ordering parameters. The example retrieves the count of returned records.

```python
import os

from tango import TangoClient

client = TangoClient(api_key=os.environ["TANGO_API_KEY"])
data = client._get(
    "/api/otidvs/",
    params={"search": "DARPA", "ordering": "-award_date", "limit": 10},
)
print("count:", data.get("count"))

```

--------------------------------

### Context-Aware Search Example (API)

Source: https://tango.makegov.com/docs/federal-agency-hierarchy

This example illustrates Tango's context-aware search functionality. By searching for 'Treasury OIG', the API can identify the Office of Inspector General within the Treasury Department, even if similar terms exist in other departments, demonstrating intelligent search capabilities.

```http
GET /api/organizations/?search=Treasury OIG
```

--------------------------------

### Search Contracts

Source: https://tango.makegov.com/docs/getting-started/quick-start

Search for government contracts based on various criteria, including recipient name, award date, and result limits. Supports pagination and response shaping.

```APIDOC
## GET /api/contracts/

### Description
Searches for government contracts and returns a paginated list of results. Supports filtering, sorting, and response shaping.

### Method
GET

### Endpoint
/api/contracts/

### Parameters
#### Path Parameters
None

#### Query Parameters
- **recipient** (string) - Optional - Filters contracts by recipient name (partial match).
- **ordering** (string) - Optional - Specifies the sorting order. Use a hyphen for descending (e.g., `-award_date`).
- **limit** (integer) - Optional - Limits the number of results per page.
- **page** (integer) - Optional - Specifies the page number for paginated results.
- **shape** (string) - Optional - Specifies which fields to include in the response. Nested fields can be accessed using dot notation or parentheses (e.g., `recipient(display_name,uei)`).

#### Request Body
None

### Request Example (Basic Search)
```bash
curl -H "X-API-KEY: your-api-key-here" \
  "https://tango.makegov.com/api/contracts/?recipient=ACME&ordering=-award_date&limit=5"
```

### Request Example (With Response Shaping)
```bash
curl -H "X-API-KEY: your-api-key-here" \
  "https://tango.makegov.com/api/contracts/?shape=key,piid,award_date,recipient(display_name,uei)&limit=5"
```

### Response
#### Success Response (200)
- **count** (integer) - The total number of contracts matching the query.
- **next** (string) - URL for the next page of results, or null if it's the last page.
- **previous** (string) - URL for the previous page of results, or null if it's the first page.
- **results** (array) - A list of contract objects.
  - **key** (string) - Unique identifier for the contract award.
  - **piid** (string) - Contract identifier.
  - **recipient** (object) - Information about the contract recipient.
    - **name** (string) - The name of the recipient.
    - **uei** (string) - The Unique Entity Identifier of the recipient.
  - **award_date** (string) - The date the contract was awarded (YYYY-MM-DD).
  - **obligated** (number) - The amount obligated under the contract.
  - **description** (string) - A brief description of the contract.

#### Response Example (Shaped)
```json
{
  "count": 1250,
  "results": [
    {
      "key": "CONT_AWD_47QSWA24P0BWF_4732_-NONE-_-NONE-",
      "piid": "47QSWA24P0BWF",
      "award_date": "2024-01-15",
      "recipient": {
        "display_name": "ACME Corporation",
        "uei": "ZMXAHH8M8VL8"
      }
    }
  ]
}
```
```

--------------------------------

### Perform Response Shaping for Contracts (cURL)

Source: https://tango.makegov.com/docs/getting-started/quick-start

This cURL example illustrates response shaping, allowing you to request only specific fields from the API. It retrieves contract keys, PIIDs, award dates, and nested recipient information (name and UEI), limiting the results to 5.

```shell
curl -H "X-API-KEY: your-api-key-here" \ 
  "https://tango.makegov.com/api/contracts/?shape=key,piid,award_date,recipient(display_name,uei)&limit=5"
```

--------------------------------

### Get Sample Webhook Payload (GET /webhooks/endpoints/sample-payload/)

Source: https://tango.makegov.com/docs/webhooks-user-guide

Retrieves a sample webhook payload for testing handler implementations. Can fetch samples for all event types or a specific event type by providing the 'event_type' query parameter.

```http
GET /webhooks/endpoints/sample-payload/?event_type=awards.new_award
```

--------------------------------

### Search for Contracts (cURL)

Source: https://tango.makegov.com/docs/getting-started/quick-start

This cURL command demonstrates how to search for government contracts. It filters by recipient name ('ACME'), orders the results by award date in descending order, and limits the output to 5 contracts.

```shell
curl -H "X-API-KEY: your-api-key-here" \ 
  "https://tango.makegov.com/api/contracts/?recipient=ACME&ordering=-award_date&limit=5"
```

--------------------------------

### Subscribe by Notice Type (JSON)

Source: https://tango.makegov.com/docs/webhooks-user-guide

Sets up a subscription to receive notifications for opportunities based on their notice type. For example, filtering for 'pre-solicitation' notices.

```json
{
  "subscription_name": "SAM notices: Pre-solicitation",
  "payload": {
    "records": [
      {
        "event_type": "opportunities.updated",
        "subject_type": "notice_type",
        "subject_ids": ["p"]
      }
    ]
  }
}
```

--------------------------------

### API Response Headers Example

Source: https://tango.makegov.com/docs/getting-started/authentication

An example of response headers returned by the Tango API, which provide information about API usage, including remaining requests, rate limits, and execution time.

```text
X-Requests-Remaining: 95
X-RateLimit-Limit: 100
X-RateLimit-Reset: 1640995200
X-Execution-Time: 0.045s

```

--------------------------------

### Sample Webhook Payload Structure

Source: https://tango.makegov.com/docs/webhooks-user-guide

An example of a complete webhook payload, including timestamp, events, subjects, and subscription requests. This structure is returned when requesting a sample payload.

```json
{
  "event_type": "awards.new_award",
  "sample_delivery": {
    "timestamp": "2024-01-15T10:30:00Z",
    "events": [
      {
        "event_type": "awards.new_award",
        "created_at": "2024-01-15T10:29:12.123Z",
        "change": "new_award",
        "award_type": "contract",
        "award_key": "CONT_AWD_12345_9700_SPE2DX22D0001_9700",
        "recipient_id": "UEI123ABC"
      }
    ]
  },
  "sample_subjects": [
    {"subject_type": "entity", "subject_id": "UEI123ABC"},
    {"subject_type": "award", "subject_id": "CONT_AWD_12345_9700_SPE2DX22D0001_9700"}
  ],
  "sample_subscription_requests": {
    "by_subject_type": {
      "entity": {
        "subscription_name": "Sample: awards.new_award by entity",
        "payload": {
          "records": [
            {"event_type": "awards.new_award", "subject_type": "entity", "subject_ids": ["UEI123ABC"]}
          ]
        }
      }
    },
    "catch_all": {
      "subscription_name": "Sample: awards.new_award (catch-all)",
      "payload": {
        "records": [
          {"event_type": "awards.new_award", "subject_type": "entity", "subject_ids": []}
        ]
      }
    }
  }
}
```

--------------------------------

### List Agencies using Python and Node.js SDKs

Source: https://tango.makegov.com/docs/api-reference/agencies

Demonstrates how to list agencies using the tango-python and tango-node SDKs. Both examples show initializing the client with an API key and fetching a list of agencies with a specified limit. The output iterates through the results and prints the code and name of each agency.

```python
import os

from tango import TangoClient

client = TangoClient(api_key=os.environ["TANGO_API_API_KEY"])
resp = client.list_agencies(limit=25)

for a in resp.results:
    print(a.code, a.name)

```

```javascript
import { TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });
const resp = await client.listAgencies({ limit: 25 });

for (const a of resp.results) {
  console.log(a.code, a.name);
}

```

--------------------------------

### List Offices via HTTP Helper (Python)

Source: https://tango.makegov.com/docs/api-reference/offices

This Python snippet demonstrates how to list offices using the TangoClient's internal HTTP helper. It shows how to pass search parameters, page number, and limit for pagination. Requires the TANGO_API_KEY environment variable.

```python
import os

from tango import TangoClient

client = TangoClient(api_key=os.environ["TANGO_API_KEY"])
data = client._get("/api/offices/", params={"search": "OIG", "page": 1, "limit": 25})
print("count:", data.get("count"))
```

--------------------------------

### List Grants with Node.js SDK

Source: https://tango.makegov.com/docs/api-reference/grants

Illustrates how to retrieve grant opportunities using the @makegov/tango-node SDK. This example includes filtering by agency and search query, specifying the order and limit of results. It requires the TANGO_API_KEY environment variable.

```javascript
import { ShapeConfig, TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });
const resp = await client.listGrants({
  agency: "HHS",
  search: "opioid",
  ordering: "-posted_date",
  limit: 10,
  shape: ShapeConfig.GRANTS_MINIMAL,
});

for (const g of resp.results) {
  console.log(g.grant_id, g.posted_date, g.title);
}

```

--------------------------------

### Get Task Orders for a Vehicle

Source: https://tango.makegov.com/docs/getting-started/vehicles

This is a basic example of retrieving all task orders associated with a specific vehicle using its UUID. It requires an API key and the vehicle's UUID.

```curl
curl -H "X-API-KEY: <key>" \
  "https://tango.makegov.com/api/vehicles/<vehicle-uuid>/orders/?page=1"
```

--------------------------------

### Search Opportunities with Shaping (Python)

Source: https://tango.makegov.com/docs/api-reference/opportunities

Demonstrates how to search for opportunities using the tango-python SDK, applying filters for search terms and agency, and shaping the output to a minimal format. Requires TANGO_API_KEY environment variable.

```python
import os

from tango import ShapeConfig, TangoClient

client = TangoClient(api_key=os.environ["TANGO_API_KEY"])
resp = client.list_opportunities(
    search="cybersecurity",
    agency="DOD",
    limit=10,
    shape=ShapeConfig.OPPORTUNITIES_MINIMAL,
)

for o in resp.results:
    print(o.opportunity_id, o.title)

```

--------------------------------

### List Notices (Node.js SDK)

Source: https://tango.makegov.com/docs/api-reference/notices

Illustrates how to list notices using the @makegov/tango-node SDK. This example shows client initialization with an API key and filtering notices by agency, type, and limit. It then logs the notice ID and title for each result.

```javascript
import { ShapeConfig, TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });
const resp = await client.listNotices({
  agency: "DOD",
  notice_type: "presol",
  limit: 10,
  shape: ShapeConfig.NOTICES_MINIMAL,
});

for (const n of resp.results) {
  console.log(n.notice_id, n.title);
}

```

--------------------------------

### List Contracts with Search, Filtering, and Ordering (Python)

Source: https://tango.makegov.com/docs/api-reference/contracts

This Python SDK example demonstrates how to list contracts using the Tango client. It shows how to apply filters for keywords, awarding agency, and fiscal year, and how to specify ordering and limit the results. The `ShapeConfig.CONTRACTS_MINIMAL` is used to shape the response data.

```python
import os

from tango import ShapeConfig, TangoClient

client = TangoClient(api_key=os.environ["TANGO_API_API_KEY"])

resp = client.list_contracts(
    keyword="cloud services",  # SDK maps to API param: search
    awarding_agency="4700",  # GSA
    fiscal_year=2024,
    sort="award_date",  # SDK maps (sort+order) -> API ordering
    order="desc",
    limit=10,
    shape=ShapeConfig.CONTRACTS_MINIMAL,
)

for c in resp.results:
    print(c.piid, c.award_date, c.recipient.display_name)

```

--------------------------------

### List Assistance Listings using Python SDK

Source: https://tango.makegov.com/docs/api-reference/assistance-listings

Demonstrates how to fetch a list of assistance listings using the tango-python SDK. It initializes the client with an API key and makes a GET request to the /api/assistance_listings/ endpoint with pagination parameters. The response includes the count of listings.

```python
import os

from tango import TangoClient

client = TangoClient(api_key=os.environ["TANGO_API_KEY"])
data = client._get("/api/assistance_listings/", params={"page": 1, "limit": 25})
print("count:", data.get("count"))

```

--------------------------------

### List Offices via HTTP Helper (Node.js)

Source: https://tango.makegov.com/docs/api-reference/offices

This Node.js snippet shows how to list offices using the TangoClient's http object. It illustrates how to include search, page, and limit parameters for filtering and pagination. The TANGO_API_KEY environment variable must be set.

```javascript
import { TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });
const http = (client as any).http;
const data = await http.get("/api/offices/", { search: "OIG", page: 1, limit: 25 });
console.log("count:", data.count);
```

--------------------------------

### Get Entity Detail (GET /api/entities/{uei}/)

Source: https://tango.makegov.com/docs/api-reference/entities

Retrieves detailed information for a specific entity using its UEI. The UEI lookup is case-insensitive.

```APIDOC
## GET /api/entities/{uei}/

### Description
Retrieves detailed information for a specific entity identified by its Unique Entity Identifier (UEI). The UEI lookup is case-insensitive.

### Method
GET

### Endpoint
/api/entities/{uei}/

#### Path Parameters
- **uei** (string) - Required - The Unique Entity Identifier (UEI) of the entity to retrieve.

### Request Example
```
GET /api/entities/ZQGGHJH74DW7/
```

### Response
#### Success Response (200)
- **uei** (string) - The Unique Entity Identifier of the entity.
- **legal_business_name** (string) - The legal business name of the entity.
- Other detailed fields about the entity.

#### Response Example
```json
{
  "uei": "ZQGGHJH74DW7",
  "legal_business_name": "ACME CORPORATION",
  "address": {
    "street": "123 MAIN ST",
    "city": "ANYTOWN",
    "state": "VA",
    "zip_code": "12345"
  },
  "created_date": "2023-01-01T00:00:00Z"
}
```
```

--------------------------------

### Get Vehicle Orders

Source: https://tango.makegov.com/docs/api-reference/contracts

Retrieves task orders under a specific vehicle.

```APIDOC
## GET /api/vehicles/{uuid}/orders/

### Description
Retrieves a list of task orders under a specific vehicle, identified by its UUID.

### Method
GET

### Endpoint
/api/vehicles/{uuid}/orders/

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The UUID of the vehicle.

#### Query Parameters
- **limit** (integer) - Optional - Number of results per page.
- **cursor** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **orders** (array) - List of task order objects under the vehicle.

#### Response Example
```json
{
  "orders": [
    {
      "order_id": "order_222",
      "order_date": "2024-04-05",
      "order_amount": 75000.00
    }
  ],
  "page_info": {
    "next_cursor": "some_cursor_string",
    "next": "/api/vehicles/VEHICLE-UUID-123/orders/?limit=10&cursor=some_cursor_string"
  }
}
```
```

--------------------------------

### Cursor Pagination with Tango Client

Source: https://tango.makegov.com/docs/api-reference/contracts

Demonstrates cursor pagination using the Tango client in Python and Node.js. It shows how to fetch a list of contracts, extract the cursor from the 'next' URL, and use it to retrieve the next page of results. Requires TANGO_API_KEY environment variable.

```python
import os
from urllib.parse import parse_qs, urlparse

from tango import TangoClient

client = TangoClient(api_key=os.environ["TANGO_API_KEY"])

resp = client.list_contracts(limit=25, sort="award_date", order="desc")
print("next:", resp.next)

if resp.next:
    qs = parse_qs(urlparse(resp.next).query)
    cursor = (qs.get("cursor") or [None])[0]
    if cursor:
        resp2 = client.list_contracts(limit=25, cursor=cursor, sort="award_date", order="desc")
        print("page 2 results:", len(resp2.results))

```

```javascript
import { TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });

const resp = await client.listContracts({ limit: 25, sort: "award_date", order: "desc" });
console.log("next:", resp.next);

if (resp.next) {
  const url = new URL(resp.next);
  const cursor = url.searchParams.get("cursor");
  if (cursor) {
    const resp2 = await client.listContracts({ limit: 25, cursor, sort: "award_date", order: "desc" });
    console.log("page 2 results:", resp2.results.length);
  }
}

```

--------------------------------

### Get Contract Subawards

Source: https://tango.makegov.com/docs/api-reference/contracts

Retrieves subawards scoped to a specific contract.

```APIDOC
## GET /api/contracts/{key}/subawards/

### Description
Retrieves a list of subawards that are scoped to a specific contract, identified by its unique key.

### Method
GET

### Endpoint
/api/contracts/{key}/subawards/

### Parameters
#### Path Parameters
- **key** (string) - Required - The unique identifier of the contract.

#### Query Parameters
- **limit** (integer) - Optional - Number of results per page.
- **cursor** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **subawards** (array) - List of subaward objects.

#### Response Example
```json
{
  "subawards": [
    {
      "subaward_id": "sub_xyz789",
      "recipient_name": "Subcontractor LLC",
      "amount": 10000.00
    }
  ],
  "page_info": {
    "next_cursor": "some_cursor_string",
    "next": "/api/contracts/12345/subawards/?limit=10&cursor=some_cursor_string"
  }
}
```
```

--------------------------------

### Get Contract Transactions

Source: https://tango.makegov.com/docs/api-reference/contracts

Retrieves transactions associated with a specific contract.

```APIDOC
## GET /api/contracts/{key}/transactions/

### Description
Retrieves a list of transactions associated with a specific contract, identified by its unique key.

### Method
GET

### Endpoint
/api/contracts/{key}/transactions/

### Parameters
#### Path Parameters
- **key** (string) - Required - The unique identifier of the contract.

#### Query Parameters
- **limit** (integer) - Optional - Number of results per page.
- **cursor** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **transactions** (array) - List of transaction objects.

#### Response Example
```json
{
  "transactions": [
    {
      "transaction_id": "txn_abc123",
      "date": "2024-02-01",
      "amount": 50000.00
    }
  ],
  "page_info": {
    "next_cursor": "some_cursor_string",
    "next": "/api/contracts/12345/transactions/?limit=10&cursor=some_cursor_string"
  }
}
```
```

--------------------------------

### GET /api/contracts/{key}/

Source: https://tango.makegov.com/docs/data-dictionary/contracts

Retrieves detailed information about a specific contract award using its canonical identifier.

```APIDOC
## GET /api/contracts/{key}/

### Description
Retrieves detailed information about a specific contract award using its canonical identifier.

### Method
GET

### Endpoint
`/api/contracts/{key}/`

### Parameters
#### Path Parameters
- **key** (String) - Required - The canonical award identifier derived from FPDS/USAspending award keys.

#### Query Parameters
- **shape** (String) - Optional - Specifies which fields to include in the response. If not provided, a subset of commonly-used fields is returned. See Response Shaping for details.

### Request Example
```
GET /api/contracts/ABC-12345-XYZ/
```

### Response
#### Success Response (200)
- **key** (String) - Canonical award identifier.
- **piid** (String) - Procurement Instrument Identifier.
- **award_date** (Date) - Date the contract was awarded.
- **award_type** (Object) - Type of award (e.g., contract type code and description).
- **naics_code** (Integer) - NAICS code on the award.
- **psc_code** (String) - Product/Service Code on the award.
- **total_contract_value** (Decimal) - Total value of the contract.
- **base_and_exercised_options_value** (Decimal) - Base contract value plus exercised options.
- **fiscal_year** (Integer) - Federal fiscal year of the award.
- **obligated** (Decimal) - Total obligated amount on the contract.
- **description** (String) - Contract description or title.
- **set_aside** (Object) - Set-aside type.
- **transactions** (Array) - List of transaction/modification records.
- **subawards_summary** (Object) - Summary of subawards under this contract.

#### Response Example
```json
{
  "key": "ABC-12345-XYZ",
  "piid": "FA873020F0001",
  "award_date": "2020-09-30",
  "award_type": {
    "code": "D",
    "description": "Definitive Contract"
  },
  "naics_code": 541519,
  "psc_code": "DA01",
  "total_contract_value": 1000000.00,
  "base_and_exercised_options_value": 1000000.00,
  "fiscal_year": 2020,
  "obligated": 1000000.00,
  "description": "Cloud Computing Services",
  "set_aside": null,
  "transactions": [
    {
      "modification_number": "0000",
      "transaction_date": "2020-09-30",
      "obligated": 1000000.00,
      "description": "Initial Contract",
      "action_type": "A"
    }
  ],
  "subawards_summary": {
    "count": 5,
    "total_amount": 50000.00
  }
}
```
```

--------------------------------

### List Assistance Listings using Node.js SDK

Source: https://tango.makegov.com/docs/api-reference/assistance-listings

Shows how to retrieve a list of assistance listings via the tango-node SDK. It sets up the TangoClient with an API key and uses the internal HTTP helper to perform a GET request to the /api/assistance_listings/ endpoint, specifying page and limit. The output displays the total count of listings.

```javascript
import { TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });
const http = (client as any).http;

const data = await http.get("/api/assistance_listings/", { page: 1, limit: 25 });
console.log("count:", data.count);

```

--------------------------------

### Get Entity Contracts

Source: https://tango.makegov.com/docs/api-reference/contracts

Retrieves contracts associated with a specific entity (UEI).

```APIDOC
## GET /api/entities/{uei}/contracts/

### Description
Retrieves a list of contracts associated with a specific entity, identified by its Unique Entity Identifier (UEI).

### Method
GET

### Endpoint
/api/entities/{uei}/contracts/

### Parameters
#### Path Parameters
- **uei** (string) - Required - The Unique Entity Identifier (UEI) of the entity.

#### Query Parameters
- **limit** (integer) - Optional - Number of results per page.
- **cursor** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **contracts** (array) - List of contract objects associated with the entity.

#### Response Example
```json
{
  "contracts": [
    {
      "key": "67890",
      "piid": "FA877987654321",
      "award_date": "2023-11-20"
    }
  ],
  "page_info": {
    "next_cursor": "some_cursor_string",
    "next": "/api/entities/ABCDEFG12345/contracts/?limit=10&cursor=some_cursor_string"
  }
}
```
```

--------------------------------

### List Notices (Python SDK)

Source: https://tango.makegov.com/docs/api-reference/notices

Demonstrates how to list notices using the tango-python SDK. It shows how to initialize the client with an API key and filter notices by agency, type, and limit. The output iterates through the results, printing the notice ID and title.

```python
import os

from tango import ShapeConfig, TangoClient

client = TangoClient(api_key=os.environ["TANGO_API_KEY"])
resp = client.list_notices(
    agency="DOD",
    notice_type="presol",
    limit=10,
    shape=ShapeConfig.NOTICES_MINIMAL,
)

for n in resp.results:
    print(n.notice_id, n.title)

```

--------------------------------

### Get PSC Detail

Source: https://tango.makegov.com/docs/api-reference/psc

Retrieves detailed information for a specific Product/Service Code.

```APIDOC
## GET /api/psc/{code}/

### Description
Retrieves detailed information for a specific Product/Service Code identified by its code.

### Method
GET

### Endpoint
/api/psc/{code}/

### Path Parameters
- **code** (string) - Required - The Product/Service Code to retrieve details for.

### Response
#### Success Response (200)
- **code** (string) - The Product/Service Code.
- **description** (string) - The description of the PSC.

#### Response Example
```json
{
  "code": "A",
  "description": "Services (Except Education, Health Care, and Public Administration Services)"
}
```
```

--------------------------------

### List Contracts with Search, Filtering, and Ordering (Node.js)

Source: https://tango.makegov.com/docs/api-reference/contracts

This Node.js SDK example demonstrates how to list contracts using the Tango client. It shows how to apply filters for keywords, awarding agency, and fiscal year, and how to specify ordering and limit the results. The `ShapeConfig.CONTRACTS_MINIMAL` is used to shape the response data.

```javascript
import { ShapeConfig, TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });

const resp = await client.listContracts({
  keyword: "cloud services", // SDK maps to API param: search
  awarding_agency: "4700", // GSA
  fiscal_year: 2024,
  sort: "award_date", // SDK maps (sort+order) -> API ordering
  order: "desc",
  limit: 10,
  shape: ShapeConfig.CONTRACTS_MINIMAL,
});

for (const c of resp.results) {
  console.log(c.piid, c.award_date, c.recipient.display_name);
}

```

--------------------------------

### Get IDV Awards

Source: https://tango.makegov.com/docs/api-reference/contracts

Retrieves child awards under an Indefinite Delivery Vehicle (IDV).

```APIDOC
## GET /api/idvs/{key}/awards/

### Description
Retrieves a list of child awards under a specific Indefinite Delivery Vehicle (IDV), identified by its key.

### Method
GET

### Endpoint
/api/idvs/{key}/awards/

### Parameters
#### Path Parameters
- **key** (string) - Required - The unique identifier of the IDV.

#### Query Parameters
- **limit** (integer) - Optional - Number of results per page.
- **cursor** (string) - Optional - Cursor for pagination.

### Response
#### Success Response (200)
- **awards** (array) - List of award objects under the IDV.

#### Response Example
```json
{
  "awards": [
    {
      "key": "award_111",
      "piid": "IDV-AWARD-001",
      "award_date": "2024-03-10"
    }
  ],
  "page_info": {
    "next_cursor": "some_cursor_string",
    "next": "/api/idvs/IDVXYZ789/awards/?limit=10&cursor=some_cursor_string"
  }
}
```
```

--------------------------------

### GET /api/otas/{key}/

Source: https://tango.makegov.com/docs/data-dictionary/otas

Retrieves details for a specific Other Transaction Agreement (OTA) using its canonical award identifier.

```APIDOC
## GET /api/otas/{key}/

### Description
Retrieves details for a specific Other Transaction Agreement (OTA) using its canonical award identifier.

### Method
GET

### Endpoint
/api/otas/{key}/

### Parameters
#### Path Parameters
- **key** (String) - Required - The canonical award identifier derived from FPDS award keys. This is used for lookups.

#### Query Parameters
- **shape** (String) - Optional - Specifies which fields to include in the response. See Response Shaping for details. Available expansions include: `recipient`, `place_of_performance`, `parent_award`, `awarding_office`, `funding_office`, `period_of_performance`, `award_type`, `transactions`, `naics`, `psc`.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **key** (String) - Canonical award identifier (FPDS).
- **piid** (String) - Procurement Instrument Identifier.
- **award_date** (Date) - Date the OTA was awarded.
- **naics_code** (Integer) - NAICS code on the award.
- **psc_code** (String) - Product/Service Code on the award.
- **total_contract_value** (Decimal) - Total value.
- **base_and_exercised_options_value** (Decimal) - Base plus exercised options.
- **fiscal_year** (Integer) - Federal fiscal year.
- **obligated** (Decimal) - Total obligated amount.
- **description** (String) - OTA description/title.
- **award_type** (Object) - Award type. Can be expanded for `code` and `description`.
- **type_of_ot_agreement** (Object) - Type of OT agreement.
- **extent_competed** (String) - Extent competed.
- **consortia** (String) - Consortia indicator.
- **transactions** (Array) - Modification/transaction records. Can be expanded for same fields as contracts.

#### Response Example
```json
{
  "key": "ABC-123",
  "piid": "FA873020C0001",
  "award_date": "2020-09-30",
  "naics_code": 541519,
  "psc_code": "DB01",
  "total_contract_value": 1000000.00,
  "base_and_exercised_options_value": 1000000.00,
  "fiscal_year": 2020,
  "obligated": 1000000.00,
  "description": "Cloud Computing Services",
  "award_type": {
    "code": "OTA",
    "description": "Other Transaction Agreement"
  },
  "type_of_ot_agreement": {
    "code": "OTA",
    "description": "Other Transaction Agreement"
  },
  "extent_competed": "D",
  "consortia": "N",
  "transactions": []
}
```
```

--------------------------------

### Search Opportunities with Shaping (Node.js)

Source: https://tango.makegov.com/docs/api-reference/opportunities

Illustrates searching for opportunities via the @makegov/tango-node SDK, including search and agency filtering, and specifying a minimal shape for the response. Requires TANGO_API_KEY environment variable.

```javascript
import { ShapeConfig, TangoClient } from "@makegov/tango-node";

const client = new TangoClient({ apiKey: process.env.TANGO_API_KEY });
const resp = await client.listOpportunities({
  search: "cybersecurity",
  agency: "DOD",
  limit: 10,
  shape: ShapeConfig.OPPORTUNITIES_MINIMAL,
});

for (const o of resp.results) {
  console.log(o.opportunity_id, o.title);
}

```

--------------------------------

### Get PSC Metrics

Source: https://tango.makegov.com/docs/api-reference/psc

Retrieves time-series obligation/award metrics for a specific PSC code.

```APIDOC
## GET /api/psc/{code}/metrics/<months>/<period_grouping>/

### Description
Retrieves time-series obligation/award metrics for a given PSC code over a specified period.

### Method
GET

### Endpoint
/api/psc/{code}/metrics/<months>/<period_grouping>/

### Path Parameters
- **code** (string) - Required - The Product/Service Code.
- **months** (integer) - Required - The number of months to include in the metrics.
- **period_grouping** (string) - Required - The grouping period for the metrics (e.g., 'month', 'quarter', 'year').

### Response
#### Success Response (200)
- **data** (array) - An array of metric data points.

#### Response Example
```json
{
  "data": [
    {
      "period": "2023-01",
      "obligated_amount": 100000,
      "awarded_amount": 95000
    }
  ]
}
```
```

--------------------------------

### Search Task Order Descriptions

Source: https://tango.makegov.com/docs/getting-started/vehicles

This example demonstrates how to search for task orders based on keywords in their descriptions using the `?search=` parameter. An API key and vehicle UUID are required.

```curl
curl -H "X-API-KEY: <key>" \
  "https://tango.makegov.com/api/vehicles/<vehicle-uuid>/orders/?search=software"
```

--------------------------------

### Test Webhook Delivery

Source: https://tango.makegov.com/docs/webhooks-user-guide

Sends a test webhook notification to your configured endpoint to verify connectivity and correct setup.

```APIDOC
## POST /webhooks/endpoints/test-delivery/

### Description
Sends a test webhook to your endpoint to verify connectivity. Returns detailed information about the delivery attempt.

### Method
POST

### Endpoint
/webhooks/endpoints/test-delivery/

### Response
#### Success Response (200 OK)
- **success** (boolean) - Indicates if the test delivery was successful.
- **status_code** (integer) - The HTTP status code received from your endpoint.
- **response_time_ms** (integer) - The time in milliseconds it took for your endpoint to respond.
- **message** (string) - A message confirming the success of the test delivery.

#### Response Example (Success)
```json
{
  "success": true,
  "status_code": 200,
  "response_time_ms": 145,
  "message": "Test delivery successful! Response time: 145ms. Your webhook endpoint is configured correctly."
}
```

#### Failure Response (e.g., 500 Internal Server Error)
- **success** (boolean) - Indicates if the test delivery failed.
- **status_code** (integer) - The HTTP status code received from your endpoint.
- **message** (string) - A message detailing the failure.
- **response_body** (string) - The first 1000 characters of the response body from your endpoint (if available).

#### Response Example (Failure)
```json
{
  "success": false,
  "status_code": 500,
  "message": "Test delivery failed with status 500. Please check your endpoint implementation and ensure it returns 2xx status codes.",
  "response_body": "<first 1000 chars of response>"
}
```
```
Tokens:
Raw