Jump to Content

API Overview

The sections below contain an overview of the Data SDK organized by function.

Data Functions

API Function	Description
`upload-file`	Create a dataset from a data upload.
`get-dataset`	Get a data record.
`download-dataset`	Download a dataset.
`update-dataset`	Update a data record with an upload.
`delete-dataset`	Delete a dataset. Deletes all data associated with the dataset.
`list-datasets`	Get all dataset records for the user.
`execute-query`	Execute a query against a data connector.
`list-data-connectors`	List all data connectors added to the authorized account.
`create-query-dataset`	Create a dataset from a query.
`create-external-dataset`	Create a dataset referencing an external URL.

Hex Tile Functions

API Function	Description
`create-hextile`	Process a dataset into Hex Tiles.
`enrich`	Enrich a dataset with Hex Tiles. Enriching refers to the process of combining a non-Hex Tile dataset with a Hex Tile dataset.
`extract`	Extract a data from a specified geometry region. All columns from the region and resolution is returned in a GeoPandas H3 dataframe.

Map Functions

API Function	Description
`create-map`	Create a map record, specifying the map state and list of associated datasets.
`copy-map`	Copy an existing map, copying the map and layer configuration.
`get-map`	Get a map record, including the full map state and list of associated datasets.
`update-map`	Update a map record, including the map state and list of associated datasets.
`replace-dataset`	Replace a dataset on a map.
`delete-map`	Delete a map record.
`list-maps`	Get all map records for the user.

Sharing Functions

API Function	Description
`get-permissions`	Get permissions for a resource. Returns user and organization access levels.
`set-permissions`	Set permissions for a resource. Configure user and organization access levels.

SDK Reference

Visit the Data SDK's SDK Reference to view all functions, methods, and parameter specifications.

Updated about 1 month ago