API Reference

Datasets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get dataset by ID

Dataset Datasets.Retrieve(DatasetRetrieveParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/datasets/{id}

Get dataset by ID

ParametersExpand Collapse

DatasetRetrieveParams parameters

required string id

Dataset ID

ReturnsExpand Collapse

class Dataset:

Metadata for a custom dataset. Datasets contain user-uploaded geospatial features separate from the OSM data.

required string ID

Dataset UUID

formatuuid

required DateTimeOffset InsertedAt

Creation timestamp (UTC)

formatdate-time

required string Name

Human-readable dataset name

required string Slug

URL-friendly identifier

required DateTimeOffset UpdatedAt

Last update timestamp (UTC)

formatdate-time

string? Attribution

Required attribution text

string? Description

Dataset description

string? License

License identifier (e.g. CC-BY-4.0)

string? SourceUrl

URL of the original data source

formaturi

Get dataset by ID

C#

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

DatasetRetrieveParams parameters = new() { ID = "id" };

var dataset = await client.Datasets.Retrieve(parameters);

Console.WriteLine(dataset);

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "NYC Bike Lanes",
  "slug": "nyc-bike-lanes",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "https://example.com"
}

Returns Examples

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "NYC Bike Lanes",
  "slug": "nyc-bike-lanes",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "https://example.com"
}