Statistical Agencies

SSB arbitrary PxWeb data query

POST a raw PxWeb query to any SSB numeric table ID. The body is the same as SSB's native PxWeb API. Sugra wraps the response in its standard envelope and extracts metadata[0].updated as meta.data_time. When the body is omitted or empty, Sugra auto-builds a top 12 query over the time dimension using every ContentsCode value from the schema.

post/api/v1/statistical-agencies/ssb/data/{table_id}

Path parameters

table_idstring required

SSB numeric table ID.

Request body

object nullable required

Raw PxWeb query body with shape {"query": [...], "response": {"format": "json"}}. Omit to use Sugra's default top 12 auto-query.

Response

Tidy observation rows for the target table.

Example response

{
  "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",
    "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"
    ]
  }
}

Changes

Changed in 1 of the 21 revisions of this API.12

Aug 8, 20264c4530760ba112See the full diff
- ○
  added the optional property code to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 503 status
  response-optional-property-added

Full history