Search State And Local Contract IDVs

Search_State_And_Local_Contract_IDVs returns state and local IDV records that capture parent contract structure, term windows, and linked award activity.

When To Use

Typical questions this tool answers well:

• Which state/local contract IDVs match a contract name, topic, issuing entity, or state?

• Which IDVs are active in specific NIGP or UNSPSC categories?

• Which states or category codes dominate a filtered IDV market segment?

• Which points of contact or related awards are attached to a target IDV?

• Which IDVs are similar to a known state/local award, IDV, opportunity, vehicle, vendor, or file?

Required Reading

1. Search_Query_Guide: Required before setting free-text query strings when search_mode is used.

2. Search_Mode_Guide: Required before choosing keyword vs semantic retrieval.

3. Date_Filtering_Guide: Required before setting date window filters.

4. Location_Filtering_Guide: Required before setting location filters.

Input Contract

• query: Free-text query string. See Required Reading: Search_Query_Guide.

  • type: string

  • required: no

  • default: n/a

• page: 1-based page index.

  • type: null|number

  • required: no

  • default: 1

• per_page: Rows per page.

  • type: null|number

  • required: no

  • default: 10

• search_mode: Query interpretation mode. See Required Reading: Search_Mode_Guide.

  • type: string

  • required: no

  • default: keyword

  • options: keyword, semantic

• award_date_range: Filter by the date the award was issued. See Required Reading: Date_Filtering_Guide.

  • type: object

  • required: no

  • default: n/a

  • shape: { from?: null|string, to?: null|string }

• state_ids: Filter by states. Use GovTribe IDs or USPS state codes. See Required Reading: Location_Filtering_Guide.

  • type: array<string>

  • required: no

  • default: n/a

• state_ids_operator: Choose whether to include or exclude values for State IDs (GovTribe or USPS code).

  • type: null|string

  • required: no

  • default: in

  • options: in, not_in

• contact_ids: Filter by points of contact. Use GovTribe IDs.

  • type: array<string>

  • required: no

  • default: n/a

• contact_ids_operator: Choose whether to include or exclude values for Contact GovTribe IDs.

  • type: null|string

  • required: no

  • default: in

  • options: in, not_in

• nigp_category_ids: Filter by NIGP categories. Use GovTribe IDs or NIGP codes.

  • type: array<string>

  • required: no

  • default: n/a

• nigp_category_ids_operator: Choose whether to include or exclude values for NIGP Category IDs (GovTribe or NIGP code).

  • type: null|string

  • required: no

  • default: in

  • options: in, not_in

• unspsc_category_ids: Filter by UNSPSC categories. Use GovTribe IDs or UNSPSC codes.

  • type: array<string>

  • required: no

  • default: n/a

• unspsc_category_ids_operator: Choose whether to include or exclude values for UNSPSC Category IDs (GovTribe or UNSPSC code).

  • type: null|string

  • required: no

  • default: in

  • options: in, not_in

• similar_filter: Find similar to the provided govtribe_type + govtribe_id.

  • type: null|object

  • required: no

  • default: n/a

  • shape: { govtribe_type: string, govtribe_id: string }

• state_and_local_contract_i_d_v_ids: Include or exclude results by GovTribe IDs.

  • type: array<string>

  • required: no

  • default: n/a

• state_and_local_contract_i_d_v_ids_operator: Choose whether to include or exclude values for GovTribe IDs.

  • type: null|string

  • required: no

  • default: in

  • options: in, not_in

• aggregations: Aggregation keys to compute.

  • type: array<string>

  • required: no

  • default: n/a

  • options: dollars_obligated_stats, top_nigp_codes_by_dollars_obligated, top_unspsc_codes_by_dollars_obligated, top_states_by_dollars_obligated, top_contract_entities_by_dollars_obligated, top_states_by_doc_count, top_unspsc_codes_by_doc_count, top_nigp_codes_by_doc_count

• sort: Sort configuration.

  • type: object

  • required: no

  • default: n/a

  • shape: { key?: null|string, direction?: null|string }

  • options: key: awardDate, _score; direction: asc, desc

• fields_to_return: Optional field list for row payloads. If omitted and per_page > 0, rows default to govtribe_id. For per_page: 0 aggregation/meta calls, this field may be omitted. Specify fields_to_return whenever the user asks for fields beyond govtribe_id, and prefer omitting it in pure aggregation workflows.

  • type: array<string>

  • required: no

  • default: n/a

  • options: govtribe_id, govtribe_ai_summary, govtribe_type, govtribe_url, name, description, awardee_name, contracting_organization, award_date, potential_completion_date, contract_number, contract_type, state, line_items, unspsc_categories, nigp_categories, government_files, state_local_contract_awards, points_of_contact

Output Contract

• Top-level keys:

  • current_page: Current page number when per_page > 0.

  • data: Array of result rows when per_page > 0.

  • from: First row position in the current page.

  • last_page: Last page number for current filters.

  • path: GovTribe search URL for this result set.

  • per_page: Applied page size.

  • to: Last row position in the current page.

  • total: Total matched row count for current query filters.

  • contains: Dataset label for the returned result set.

  • search_results_id_can_generate_saved_search: Saved-search eligibility flag.

  • search_results_id: Server-side search result identifier.

  • view_search_results_url: URL to open this exact result set.

  • aggregations: Aggregation payload keyed by requested aggregation names when requested.

• Row keys:

  • govtribe_id

  • govtribe_ai_summary

  • govtribe_type

  • govtribe_url

  • name

  • description

  • awardee_name

  • contracting_organization

  • award_date

  • potential_completion_date

  • contract_number

  • contract_type

  • state

  • line_items

  • unspsc_categories

  • nigp_categories

  • government_files

  • state_local_contract_awards

  • points_of_contact

• Relationship retrieval map:

  • government_files

    • resource_type: government_file

    • tool: Search_Government_Files

    • filter: government_file_ids

    • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

  • line_items

    • resource_type: line_item

    • tool: n/a

    • filter: n/a

    • fallback: No direct Search_* tool returns this resource class; use parent dataset filters and parent IDs.

    • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

  • nigp_categories

    • resource_type: nigp_category

    • tool: Search_Nigp_Categories

    • filter: nigp_category_ids

    • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

  • points_of_contact

    • resource_type: contact

    • tool: Search_Contacts

    • filter: contact_ids

    • nested_keys: govtribe_id, govtribe_type, name, email, govtribe_url

  • state

    • resource_type: state

    • tool: Search_States

    • filter: state_ids

    • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

  • state_local_contract_awards

    • resource_type: state_local_contract_award

    • tool: Search_State_And_Local_Contract_Awards

    • filter: state_and_local_contract_award_ids

    • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

  • unspsc_categories

    • resource_type: unspsc_category

    • tool: Search_Unspsc_Categories

    • filter: unspsc_category_ids

    • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

Usage Patterns

Pattern A: Exact IDV lookup by known identifier or phrase. Tool: Search_State_And_Local_Contract_IDVs

{
  "query": "\"SLP-25-70-0184H\"",
  "search_mode": "keyword",
  "fields_to_return": [
    "govtribe_id"
  ],
  "page": 1,
  "per_page": 10,
  "sort": {
    "key": "awardDate",
    "direction": "desc"
  }
}

Pattern B: Filter IDVs by state and category codes. Tool: Search_State_And_Local_Contract_IDVs

{
  "query": "",
  "search_mode": "keyword",
  "fields_to_return": [
    "govtribe_id"
  ],
  "page": 1,
  "per_page": 25,
  "sort": {
    "key": "_score",
    "direction": "desc"
  },
  "award_date_range": {
    "from": "now-5y/d",
    "to": "now/d"
  },
  "state_ids": [
    "CA",
    "TX"
  ],
  "state_ids_operator": "in",
  "nigp_category_ids": [
    "92040",
    "92045"
  ],
  "nigp_category_ids_operator": "in",
  "unspsc_category_ids": [
    "43231500"
  ],
  "unspsc_category_ids_operator": "in"
}

Pattern C: Similarity search from a known state/local award or opportunity. Tool: Search_State_And_Local_Contract_IDVs

{
  "query": "",
  "search_mode": "semantic",
  "fields_to_return": [
    "govtribe_id"
  ],
  "page": 1,
  "per_page": 20,
  "sort": {
    "key": "_score",
    "direction": "desc"
  },
  "similar_filter": {
    "govtribe_type": "state_local_contract_award",
    "govtribe_id": "<STATE_LOCAL_CONTRACT_AWARD_ID>"
  }
}

Pattern D: Aggregation-only market profile for state/entity/category concentration. Tool: Search_State_And_Local_Contract_IDVs

{
  "query": "",
  "search_mode": "keyword",
  "per_page": 0,
  "aggregations": [
    "dollars_obligated_stats",
    "top_states_by_doc_count",
    "top_contract_entities_by_dollars_obligated",
    "top_nigp_codes_by_dollars_obligated",
    "top_unspsc_codes_by_dollars_obligated"
  ],
  "sort": {
    "key": "_score",
    "direction": "desc"
  },
  "award_date_range": {
    "from": "now-3y/d",
    "to": "now/d"
  },
  "state_ids": [
    "OH",
    "FL"
  ]
}

Then rerun with per_page > 0 and the same filters when you need row-level entities after reviewing rollups.

Pattern E: Pull rows plus aggregations for a single request. Tool: Search_State_And_Local_Contract_IDVs

{
  "query": "software license program",
  "search_mode": "keyword",
  "fields_to_return": [
    "govtribe_id"
  ],
  "page": 1,
  "per_page": 15,
  "aggregations": [
    "top_states_by_doc_count",
    "top_nigp_codes_by_doc_count"
  ],
  "sort": {
    "direction": "desc",
    "key": "_score"
  }
}