Cross-portal federated catalog search

GET

/api/v1/socrata/federated-search

Last modified:2026-05-10 09:22:39

Maintainer:Not configured

OperationId: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.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/socrata/federated-search?q=hospital&limit=10&offset=0&only=dataset' \
--header 'x-api-key: <api-key>'

Responses

🟢200

application/json

Pooled catalog rows from all supported portals.

Bodyapplication/json

Example

{
    "data": {
        "domains_queried": "string",
        "resultSetSize": 0,
        "count": 0,
        "limit": 0,
        "offset": 0,
        "results": [
            {
                "resource": {
                    "property1": "string",
                    "property2": "string"
                },
                "classification": {
                    "property1": "string",
                    "property2": "string"
                },
                "metadata": {
                    "property1": "string",
                    "property2": "string"
                },
                "permalink": "string",
                "link": "string",
                "owner": {
                    "property1": "string",
                    "property2": "string"
                },
                "preview_image_url": "string"
            }
        ]
    },
    "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": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true
    }
}

🟠401

🟠422

🟠429

🔴503

Modified at 2026-05-10 09:22:39

SoQL row query

Portal category buckets