Assistance listings¶

Assistance listings (CFDA) reference data is exposed at /api/assistance_listings/. This is not the assistance transactions endpoint; it’s just the static reference list. For field definitions, see the Assistance Listings Data Dictionary.

Endpoints¶

• GET /api/assistance_listings/ (list)
• GET /api/assistance_listings/{number}/ (detail; {number} supports digits and .)

Filtering¶

None.

Ordering¶

/api/assistance_listings/ does not support ordering=....

Pagination¶

Assistance listings use standard page-number pagination:

• page (default 1)
• limit (default 1000, max 10000)

Response shaping¶

This endpoint supports response shaping via the shape query parameter.

• Leaves: number, title, published_date, archived_date, popular_name, objectives, applicant_eligibility, benefit_eligibility
• No expansions.

Default shape (list, no ?shape= param): number,title

Note: Detail responses (/api/assistance_listings/{number}/) use the full serializer (includes all fields) when no ?shape= param is provided.

# Include extra fields
/api/assistance_listings/?shape=number,title,objectives

# Detail with specific fields
/api/assistance_listings/10.001/?shape=number,title,objectives,popular_name

SDK examples¶

The official SDKs don’t yet expose a first-class list_assistance_listings() / listAssistanceListings() method. You can still call the endpoint via the SDK’s internal HTTP helper.

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"))

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);