Public Finance & Government

Search a portal catalog

Discovery API search against a single portal via api/catalog/v1. Free-text query across titles and descriptions, with optional filters on type (only=dataset|chart|map|filter|story), categories, and tags. Responses include resultSetSize (total matches) and results (page of catalog rows). Page with limit (1-1000) and offset.

get/api/v1/socrata/{portal}/catalog

Path parameters

portalstring required

Portal slug (e.g. nyc, chicago, cdc).

Query parameters

qstring nullable

Free-text search across dataset titles and descriptions.

limitinteger

Page size (1-1000).

offsetinteger

Page offset for pagination.

onlystring nullable

Type filter (dataset, chart, map, filter, story).

categoriesstring nullable

Comma-separated categories filter (see /categories for the portal list).

tagsstring nullable

Comma-separated tags filter.

Response

Matching catalog rows with upstream total count.

Example response

{
  "data": {
    "portal": "nyc",
    "domain": "data.cityofnewyork.us"
  },
  "meta": {
    "endpoint": "/api/v1/fred/us/cpi",
    "data_time": "2026-04-16T14:30:00Z",
    "response_time": "2026-04-16T14:30:12Z",
    "provider": "Sugra API v1.0.1",
    "data_age_days": 8.532,
    "source": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ],
    "period": "2026-Q1",
    "notes": "the UKMTO report behind these counts is dated 2026-08-21 and is 11 days old"
  }
}

Changes

Changed in 2 of the 24 revisions of this API.15

Sep 1, 2026328d061c12ca3See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Aug 8, 20264c4530760ba112See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added

Full history