Search a portal catalog

GET

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

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

Maintainer:Not configured

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

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/socrata/nyc/catalog?q=311&limit=10&offset=0&only=dataset&categories=&tags=' \
--header 'x-api-key: <api-key>'

Responses

🟢200

application/json

Matching catalog rows with upstream total count.

Bodyapplication/json

Example

{
    "data": {
        "portal": "nyc",
        "domain": "data.cityofnewyork.us",
        "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"
            }
        ],
        "timings": {
            "property1": "string",
            "property2": "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

Configured Socrata portals directory

Dataset view metadata