Explore API
The Opendatasoft Explore API v2 is organized around REST. It provides access to all the data available through the platform in a coherent, hierarchical way.…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Opendatasoft Explore API v2 is organized around REST. It provides access to all the data available through the platform in a coherent, hierarchical way.
- Only the HTTP
GETmethod is supported. - All API endpoints return JSON.
- Endpoints are organized in a hierarchical way describing the relative relationship between objects.
- All responses contain a list of links allowing easy and relevant navigation through the API endpoints.
- All endpoints use the Opendatasoft Query Language (ODSQL)). This means that, most of the time, parameters work the same way for all endpoints.
- While the
recordsendpoint is subject to a limited number of returned records, theexportsendpoint has no limitations.
Endpoints 16
Catalog
- GETQuery catalog datasets
/catalog/datasetsRetrieve available datasets. - GETList export formats
/catalog/exportsList available export formats - GETExport a catalog
/catalog/exports/:formatExport a catalog in the desired format. - GETExport a catalog in CSV
/catalog/exports/csvExport a catalog in CSV (Comma Separated Values). Specific parameters are described here - GETExport a catalog in RDF/XML (DCAT)
/catalog/exports/dcat:dcat_ap_formatExport a catalog in RDF/XML described with DCAT (Data Catalog Vocabulary). Specific parameters are described here - GETList facet values
/catalog/facetsEnumerate facet values for datasets and returns a list of values for each facet. Can be used to implement guided navigation in large result sets. - GETShow dataset information
/catalog/datasets/:dataset_idReturns a list of available endpoints for the specified dataset, with metadata and endpoints. The response includes the following links: * the attachments…
Dataset
- GETQuery dataset records
/catalog/datasets/:dataset_id/recordsPerform a query on dataset records. - GETList export formats
/catalog/datasets/:dataset_id/exportsList available export formats - GETExport a dataset
/catalog/datasets/:dataset_id/exports/:formatExport a dataset in the desired format. Note: The group_by parameter is only available on exports starting with the v2.1 - GETExport a dataset in CSV
/catalog/datasets/:dataset_id/exports/csvExport a dataset in CSV (Comma Separated Values). Specific parameters are described here - GETExport a dataset in Parquet
/catalog/datasets/:dataset_id/exports/parquetExport a dataset in Parquet. Specific parameters are described here - GETExport a dataset in GPX
/catalog/datasets/:dataset_id/exports/gpxExport a dataset in GPX. Specific parameters are described here - GETList dataset facets
/catalog/datasets/:dataset_id/facetsEnumerates facet values for records and returns a list of values for each facet. Can be used to implement guided navigation in large result sets. - GETList dataset attachments
/catalog/datasets/:dataset_id/attachmentsReturns a list of all available attachments for a dataset. - GETRead a dataset record
/catalog/datasets/:dataset_id/records/:record_idReads a single dataset record based on its identifier.
API details
- Base URL
https://opendata.umea.se/api/explore/v2.1- Authentication
- An API key in the apikey query parameter
- Operations
- 16 operations on 16 pathsGET 16
- Main resources
- Dataset 9Catalog 7
- Response formats
application/json; charset=utf-8application/json; charset=utf-8json- Description format
- OpenAPI 3.0.3, API version
v2.1 - Links
- OpenAPI document
- Listed from
- Umea's published OpenAPI description
How to test the Explore API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Explore API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the apikey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Query catalog datasets” (GET /catalog/datasets), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Explore API?
The Opendatasoft Explore API v2 is organized around REST. It provides access to all the data available through the platform in a coherent, hierarchical way.… It is listed under Data & analytics and has 16 endpoints.
Who publishes the Explore API?
It is listed from Umea's public API description (an OpenAPI document), not published by Umea on Swastik Codes. Anyone who controls opendata.umea.se can claim the profile by adding a DNS TXT record.
What is the base URL of the Explore API?
Requests go to https://opendata.umea.se/api/explore/v2.1. Endpoint paths are added to this base URL.
How do I authenticate with the Explore API?
With an API key in the apikey query parameter.
How many endpoints does the Explore API have?
16 operations on 16 paths (16 GET). The largest groups are Dataset, Catalog.
Is forking the Explore API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.