---
title: "Cross-portal federated catalog search"
method: GET
path: "/api/v1/socrata/federated-search"
tags: ["Public Finance & Government"]
---

# Cross-portal federated catalog search

`GET /api/v1/socrata/federated-search`

Federated Discovery search spanning all ten whitelisted portals via `api.us.socrata.com/api/catalog/v1`. Useful when you want to locate a dataset without knowing which agency publishes it. Response pools results across portals and annotates each row with its originating domain.

## Query parameters

- `q` string, nullable — Free-text search across catalog rows.
- `limit` integer — Page size (1-1000).
- `offset` integer — Page offset for pagination.
- `only` string, nullable — Type filter (`dataset`, `chart`, `map`, `filter`, `story`).

## Response `200`

Pooled catalog rows from all supported portals.

- EnvelopeSocrataFederatedSearchPayload
  - `data` SocrataFederatedSearchPayload, required — Response payload for `/api/v1/socrata/federated-search`.
    - `domains_queried` string, required — Comma-separated portal hostnames included in the federated search.
    - `resultSetSize` integer, nullable — Total matching rows across all queried portals.
    - `count` integer, required — Number of rows returned in this response page.
    - `limit` integer, required — Page size echoed from the request.
    - `offset` integer, required — Page offset echoed from the request.
    - `results` SocrataCatalogRow[], required — Catalog rows spanning multiple portals, ordered by upstream relevance.
      - `resource` object, nullable — Dataset identity and publisher metadata. Contains `id` (4-4 hex dataset_id), `name`, `description`, `attribution`, `createdAt`, `updatedAt`, `data_updated_at`, `metadata_updated_at`, `columns_name`, `columns_description`, `columns_datatype`, row/column counts.
      - `classification` object, nullable — Categories, tags, and domain-specific classification fields (`domain_category`, `domain_tags`, `categories`).
      - `metadata` object, nullable — Upstream metadata block - `domain`, `license`, `view_id`, `parent_id`, and publishing attributes.
      - `permalink` string, nullable — Canonical upstream URL for the dataset view.
      - `link` string, nullable — Alternate dataset link used by some Socrata deployments.
      - `owner` object, nullable — Dataset owner record - `id`, `display_name`, `profile_image_url`.
      - `preview_image_url` string, nullable — Preview thumbnail URL when rendered on the upstream portal.
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/d3e3d9c28132/schema)