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(DatasetRetrieveParamsparams = DatasetRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/datasets/{id}

Get dataset by ID

ParametersExpand Collapse

DatasetRetrieveParams params

Optional<String> id

ReturnsExpand Collapse

class Dataset:

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

String id

Dataset UUID

formatuuid

LocalDateTime insertedAt

Creation timestamp (UTC)

formatdate-time

String name

Human-readable dataset name

String slug

URL-friendly identifier

LocalDateTime updatedAt

Last update timestamp (UTC)

formatdate-time

Optional<String> attribution

Required attribution text

Optional<String> description

Dataset description

Optional<String> license

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

Optional<String> sourceUrl

URL of the original data source

formaturi

Get dataset by ID

Java

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

package com.plazafyi.example;

import com.plazafyi.client.PlazaClient;
import com.plazafyi.client.okhttp.PlazaOkHttpClient;
import com.plazafyi.models.datasets.Dataset;
import com.plazafyi.models.datasets.DatasetRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        PlazaClient client = PlazaOkHttpClient.fromEnv();

        Dataset dataset = client.datasets().retrieve("id");
    }
}

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"
}