# Datasets ## List all datasets `DatasetList Datasets.List(DatasetListParams?parameters, CancellationTokencancellationToken = default)` **get** `/api/v1/datasets` List all datasets ### Parameters - `DatasetListParams parameters` ### Returns - `class DatasetList:` List of all available datasets. - `required IReadOnlyList Datasets` Array of dataset metadata objects - `required string ID` Dataset UUID - `required DateTimeOffset InsertedAt` Creation timestamp (UTC) - `required string Name` Human-readable dataset name - `required string Slug` URL-friendly identifier - `required DateTimeOffset UpdatedAt` Last update timestamp (UTC) - `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 ### Example ```csharp DatasetListParams parameters = new(); var datasetList = await client.Datasets.List(parameters); Console.WriteLine(datasetList); ``` #### Response ```json { "datasets": [ { "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" } ] } ``` ## Create a new dataset (admin only) `Dataset Datasets.Create(DatasetCreateParamsparameters, CancellationTokencancellationToken = default)` **post** `/api/v1/datasets` Create a new dataset (admin only) ### Parameters - `DatasetCreateParams parameters` - `required string name` Human-readable dataset name - `required string slug` URL-friendly identifier (lowercase, hyphens, no spaces) - `string? attribution` Required attribution text - `string? description` Dataset description - `string? license` License identifier (e.g. CC-BY-4.0) - `string? sourceUrl` Source data URL ### Returns - `class Dataset:` Metadata for a custom dataset. Datasets contain user-uploaded geospatial features separate from the OSM data. - `required string ID` Dataset UUID - `required DateTimeOffset InsertedAt` Creation timestamp (UTC) - `required string Name` Human-readable dataset name - `required string Slug` URL-friendly identifier - `required DateTimeOffset UpdatedAt` Last update timestamp (UTC) - `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 ### Example ```csharp DatasetCreateParams parameters = new() { Name = "NYC Bike Lanes", Slug = "nyc-bike-lanes", }; var dataset = await client.Datasets.Create(parameters); Console.WriteLine(dataset); ``` #### Response ```json { "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" } ``` ## Get dataset by ID `Dataset Datasets.Retrieve(DatasetRetrieveParamsparameters, CancellationTokencancellationToken = default)` **get** `/api/v1/datasets/{id}` Get dataset by ID ### Parameters - `DatasetRetrieveParams parameters` - `required string id` Dataset ID ### Returns - `class Dataset:` Metadata for a custom dataset. Datasets contain user-uploaded geospatial features separate from the OSM data. - `required string ID` Dataset UUID - `required DateTimeOffset InsertedAt` Creation timestamp (UTC) - `required string Name` Human-readable dataset name - `required string Slug` URL-friendly identifier - `required DateTimeOffset UpdatedAt` Last update timestamp (UTC) - `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 ### Example ```csharp DatasetRetrieveParams parameters = new() { ID = "id" }; var dataset = await client.Datasets.Retrieve(parameters); Console.WriteLine(dataset); ``` #### Response ```json { "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" } ``` ## Delete a dataset `Datasets.Delete(DatasetDeleteParamsparameters, CancellationTokencancellationToken = default)` **delete** `/api/v1/datasets/{id}` Delete a dataset ### Parameters - `DatasetDeleteParams parameters` - `required string id` Dataset ID ### Example ```csharp DatasetDeleteParams parameters = new() { ID = "id" }; await client.Datasets.Delete(parameters); ``` ## Query features in a dataset `FeatureCollection Datasets.Features(DatasetFeaturesParamsparameters, CancellationTokencancellationToken = default)` **get** `/api/v1/datasets/{id}/features` Query features in a dataset ### Parameters - `DatasetFeaturesParams parameters` - `required string id` Dataset ID - `string cursor` Cursor for pagination - `Long limit` Maximum results - `Double outputBuffer` Buffer geometry by meters - `Boolean outputCentroid` Replace geometry with centroid - `string outputFields` Comma-separated property fields to include - `Boolean outputGeometry` Include geometry (default true) - `string outputInclude` Extra computed fields: bbox, distance, center - `Long outputPrecision` Coordinate decimal precision (1-15, default 7) - `Double outputSimplify` Simplify geometry tolerance in meters - `string outputSort` Sort by: distance, name, osm_id ### Returns - `class FeatureCollection:` GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body: | Header | Description | | --------------- | ------------------------------------------------ | | `X-Limit` | Requested result limit | | `X-Has-More` | `true` if more results exist | | `X-Next-Cursor` | Opaque cursor for next page (cursor pagination) | | `X-Next-Offset` | Numeric offset for next page (offset pagination) | | `Link` | RFC 8288 `rel="next"` link to the next page | Content-Type is `application/geo+json`. - `required IReadOnlyList Features` Array of GeoJSON Feature objects - `required GeoJsonGeometry Geometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `required Coordinates Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `IReadOnlyList` - `IReadOnlyList>` - `IReadOnlyList>>` - `IReadOnlyList>>>` - `required Type Type` Geometry type - `"Point"Point` - `"LineString"LineString` - `"Polygon"Polygon` - `"MultiPoint"MultiPoint` - `"MultiLineString"MultiLineString` - `"MultiPolygon"MultiPolygon` - `required IReadOnlyDictionary Properties` OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries. - `required Type Type` Always `Feature` - `"Feature"Feature` - `string ID` Compound identifier in `type/osm_id` format - `required Type Type` Always `FeatureCollection` - `"FeatureCollection"FeatureCollection` ### Example ```csharp DatasetFeaturesParams parameters = new() { ID = "id" }; var featureCollection = await client.Datasets.Features(parameters); Console.WriteLine(featureCollection); ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ], "type": "FeatureCollection" } ``` ## Domain Types ### Dataset - `class Dataset:` Metadata for a custom dataset. Datasets contain user-uploaded geospatial features separate from the OSM data. - `required string ID` Dataset UUID - `required DateTimeOffset InsertedAt` Creation timestamp (UTC) - `required string Name` Human-readable dataset name - `required string Slug` URL-friendly identifier - `required DateTimeOffset UpdatedAt` Last update timestamp (UTC) - `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 ### Dataset List - `class DatasetList:` List of all available datasets. - `required IReadOnlyList Datasets` Array of dataset metadata objects - `required string ID` Dataset UUID - `required DateTimeOffset InsertedAt` Creation timestamp (UTC) - `required string Name` Human-readable dataset name - `required string Slug` URL-friendly identifier - `required DateTimeOffset UpdatedAt` Last update timestamp (UTC) - `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