Vehicles Data Dictionary¶
This document describes the fields available in the Vehicles API endpoints (/api/vehicles/).
Overview¶
Vehicles provide a solicitation-centric grouping of multiple IDVs. Each vehicle represents a unique \(solicitation_identifier, agency identifier\) pair and can expand into the underlying IDVs via response shaping.
In federal data, each IDV award is a vehicle. In practice, people often think of a “vehicle” as the solicitation that produced many IDV awards (one per awardee). We model that higher-level grouping explicitly.
Note: The full set of fields is available via the shape query parameter. The base response includes a subset of commonly-used fields. See Response Shaping for details.
Update Frequency¶
Vehicle data is refreshed via the refresh_vehicles management command.
Fields¶
| Field | Type | Description | Source |
|---|---|---|---|
uuid | UUID | Stable identifier for the vehicle in Tango. Deterministic from solicitation_identifier + agency identifier derived from the IDV key. | Tango |
solicitation_identifier | String | Solicitation identifier shared by the underlying IDVs. | FPDS (via awards) |
agency_id | String | Agency identifier derived from the IDV award key suffix (award-key convention). | Tango |
organization_id | UUID | Best-effort mapping to an Organization (agencies_organization.key) for consistent agency joins/filtering. | Tango (derived) |
vehicle_type | Object | Aggregated IDV type for the vehicle, derived from underlying IDVs. Returned as {code, description} (e.g., {code: "A", description: "GWAC"}). | FPDS (via awards) |
fiscal_year | Integer | Representative fiscal year for the vehicle (derived from the underlying IDVs). | FPDS (via awards) |
agency_details | Object | Aggregated awarding/funding office details derived from underlying IDVs. | FPDS (via awards) |
descriptions | Array[String] | Set of distinct descriptions found across the underlying IDVs. | FPDS (via awards) |
competition_details | Object | Aggregated competition information derived from the underlying IDVs. | FPDS (via awards) |
type_of_idc | Object | Aggregated IDC type for the vehicle, derived from underlying IDVs. Returned as {code, description} (e.g., {code: "A", description: "Indefinite Delivery / Requirements"}). | FPDS (via awards) |
contract_type | Object | Aggregated contract type for the vehicle, derived from underlying IDVs. Returned as {code, description} (e.g., {code: "J", description: "Firm Fixed Price"}). | FPDS (via awards) |
awardee_count | Integer | Number of IDVs in the vehicle (computed from a materialized view). | Tango |
order_count | Integer | Total number of child awards/orders under the vehicle's IDVs (computed from a materialized view). | Tango |
vehicle_obligations | Decimal | Sum of obligations across child awards/orders under the vehicle's IDVs (computed from a materialized view). | Tango |
vehicle_contracts_value | Decimal | Sum of total contract value across child awards/orders under the vehicle's IDVs (computed from a materialized view). | Tango |
solicitation_title | String | Title of the solicitation from the latest SAM.gov notice (via linked Opportunity). | SAM.gov (via opportunities) |
solicitation_description | String | Description of the solicitation from the latest SAM.gov notice (via linked Opportunity). | SAM.gov (via opportunities) |
solicitation_date | Date | First notice date from the linked SAM.gov Opportunity. | SAM.gov (via opportunities) |
naics_code | Integer | NAICS code from the linked SAM.gov Opportunity. | SAM.gov (via opportunities) |
psc_code | String | Product/Service Code from the linked SAM.gov Opportunity. | SAM.gov (via opportunities) |
set_aside | String | Set-aside type from the linked SAM.gov Opportunity. | SAM.gov (via opportunities) |
Expansions (via shape)¶
awards¶
Expands to the underlying IDVs that make up the vehicle.
opportunity¶
Expands to the linked SAM.gov Opportunity (if present). Supports all Opportunity shaping fields and expansions (e.g., office, attachments, meta).
competition_details¶
Expands the competition_details JSON object, allowing you to select specific fields. Available fields: commercial_item_acquisition_procedures, evaluated_preference, extent_competed, most_recent_solicitation_date, number_of_offers_received, original_solicitation_date, other_than_full_and_open_competition, set_aside, simplified_procedures_for_certain_commercial_items, small_business_competitiveness_demonstration_program, solicitation_identifier, solicitation_procedures, or * for all fields.
Example:
/api/vehicles/<vehicle-uuid>/?shape=uuid,solicitation_identifier,awardees(key,uuid,piid,recipient(display_name,uei))
Search¶
- Vehicle list search:
GET /api/vehicles/?search=...searches across vehicle metadata and aggregated award search terms. - Awardee-within-vehicle filtering:
GET /api/vehicles/<vehicle-uuid>/?shape=...,awardees(...)&search=...filters the expanded awardees.