Public Finance & Government

Dataset column schema

Changed on

Column schema via api/views/{dataset_id}/columns.json. Returns field names (SoQL identifiers), display names, data types (number, text, calendar_date, point, etc.), and author descriptions. Use this to discover the exact fieldName values you should pass to $select, $where, $order on the rows endpoint.

get/api/v1/socrata/{portal}/dataset-columns/{dataset_id}

Request

  • Base URL: https://sugra.ai
  • URL: https://sugra.ai/api/v1/socrata/{portal}/dataset-columns/{dataset_id}
  • Auth: API key in header x-api-key

Path parameters

portalstring required

Portal slug (e.g. nyc).

dataset_idstring required

Socrata 4-4 hex dataset identifier.

Response

Column definitions for the dataset schema.

Example response

{
  "data": {
    "portal": "nyc",
    "domain": "data.cityofnewyork.us",
    "dataset_id": "erm2-nwe9"
  },
  "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"
    ],
    "stale_since": "2026-09-08T12:00:00Z",
    "period": "2026-Q1",
    "notes": "the UKMTO report behind these counts is dated 2026-08-21 and is 11 days old"
  }
}

Changes