Data SDK
Installation
To get started with the Data SDK, visit the appropriate setup guide for your environment:
- Install the Python package, allowing interfacing with the Unfolded Data SDK from Python or Jupyter Notebooks.
- Install the CLI (Command Line Interface) package, allowing access to the Data SDK from shell scripts.
- Access the Unfolded Data SDK from the REST API, providing accessibility from any network-connected device.
API Overview
The sections below contain an overview of Unfolded Data SDK organized by function.
Map Functions
API Function | Description |
---|---|
Create a map record, specifying the map state and list of associated datasets. | |
Copy an existing map, copying the map and layer configuration. | |
Get a map record, including the full map state and list of associated datasets. | |
Update a map record, including the map state and list of associated datasets. | |
Replace a dataset on a map. | |
Delete a map record. | |
Get all map records for the user. |
Data Functions
API Function | Description |
---|---|
Create a dataset from a data upload. | |
Get a data record. | |
Download a dataset. | |
Update a data record with an upload. | |
Delete a dataset. Deletes all data associated with the dataset. | |
Get all dataset records for the user. |
Hex Tile Functions
API Function | Description |
---|---|
Process a dataset into Hex Tiles. | |
Enrich a dataset with Hex Tiles. Enriching refers to the process of combining a non-Hex Tile dataset with a Hex Tile dataset. |
API Reference
Visit the Data SDK's API Reference to view all functions, methods, and parameter specifications.
Updated 21 days ago