The SDDT Public API allows external systems to retrieve published dataset records using an operator-issued API key. It supports paginated dataset discovery, metadata filters, and full dataset detail retrieval with associated files.
An operator issues an API key for an external customer or partner integration. Keys may include an optional expiration date.
node scripts/manage-api-keys.js create --name="Acme Corp Integration"
node scripts/manage-api-keys.js create --name="Partner Portal" --expiresAt="2027-01-01"The customer app sends the API key in the request header and lists published datasets, optionally using filters.
GET /api/public/datasets?ecosystem=Estuary&page=1&limit=20
X-API-Key: snsddt_<key>The API validates the key, restricts results to published non-archived datasets, applies filters, and returns pagination metadata.
{
"data": [ ...dataset objects... ],
"pagination": {
"page": 1,
"limit": 20,
"totalCount": 84,
"totalPages": 5
}
}The customer selects a dataset ID from the list response and retrieves the full dataset record with associated files.
GET /api/public/datasets/[id]
X-API-Key: snsddt_<key>| Method | Path | Description |
|---|---|---|
| GET | /api/public/datasets | Paginated list of published datasets with optional filters. |
| GET | /api/public/datasets/[id] | Full detail for a single published dataset including files. |
| Parameter | Type | Description |
|---|---|---|
| page | number | 1-based page number. Default: 1. |
| limit | number | Results per page. Default: 20. Maximum: 100. |
| ecosystem | string | Filter by ecosystem name using partial match. |
| species | string | Filter by species name using partial match. |
| esuDps | string | Filter by ESU/DPS name using partial match. |
| population | string | Filter by population name using partial match. |
| fisherymgmtarea | string | Filter by fishery management area using partial match. |
| keywords | string | Filter by keyword or keywords using partial match. |
| contentType | string | Filter by content type using partial match. |
Only published, non-archived datasets are returned.
node scripts/manage-api-keys.js list
node scripts/manage-api-keys.js revoke --keyId=3The full API key is printed only once at creation. It cannot be recovered later, so it should be stored securely and sent to the customer out-of-band.
1. Receive API key out-of-band
2. Store the key securely
3. Add X-API-Key on every request
4. Page through /api/public/datasets
5. Fetch /api/public/datasets/[id] for selected recordsKeys are not scoped to individual SDDT user accounts, and there is no web UI for key management.