Open documentation ↗Overview
With our data marketplace solution, centralize and share your data assets with all types of user in a simple, secure and interactive way.
opendatasoft is an open data API from opendatasoft.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 36 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Open Data
- Base URL
https://public.opendatasoft.com/api/v2- Version
- 2.1.0
- Endpoints
- 36
- OpenAPI
- Specification ↗
- Spec updated
- 2021-07-12
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://public.opendatasoft.com/api/v2/" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://public.opendatasoft.com/api/v2/", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://public.opendatasoft.com/api/v2/",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | / | API entry point |
| GET | /pages | List of all pages from this portal. |
| GET | /pages/{slug} | A single page's metadata from this portal |
| GET | /{source} | Source entry points |
| GET | /{source}/aggregates | **Deprecated, use `/datasets` instead.** |
| GET | /{source}/datasets | List of available datasets, each with their endpoints, paginated. |
| GET | /{source}/datasets/{dataset_id} | List of available endpoints for the specified dataset, with metadata and endpoints. |
| GET | /{source}/datasets/{dataset_id}/aggregates | **Deprecated, use `/records` instead.** |
| GET | /{source}/datasets/{dataset_id}/attachments | Get list of all available attachments |
| GET | /{source}/datasets/{dataset_id}/attachments/{attachment_id} | Download attachment |
| GET | /{source}/datasets/{dataset_id}/exports/csv | Export dataset in CSV format |
| GET | /{source}/datasets/{dataset_id}/exports/geojson | Export dataset in GEOJSON format |
| GET | /{source}/datasets/{dataset_id}/exports/ical | Export dataset in ICAL format |
| GET | /{source}/datasets/{dataset_id}/exports/json | Export dataset in JSON format |
| GET | /{source}/datasets/{dataset_id}/exports/ov2 | Export dataset in OV2 format |
| GET | /{source}/datasets/{dataset_id}/exports/shp | Export dataset in Esri shapefile (shp) format |
| GET | /{source}/datasets/{dataset_id}/exports/xls | Export dataset in XLS (Excel) format |
| GET | /{source}/datasets/{dataset_id}/facets | Enumerate facets values for records and return a list of values for each facet. |
| PUT | /{source}/datasets/{dataset_id}/feedback | Create new feedback entry. |
| GET | /{source}/datasets/{dataset_id}/files/{file_id} | Download file |
| GET | /{source}/datasets/{dataset_id}/records | Search dataset's records. |
| GET | /{source}/datasets/{dataset_id}/records/{record_id} | Retrieve a single record based on its ID. |
| GET | /{source}/datasets/{dataset_id}/reuses | Get list of reuses |
| GET | /{source}/datasets/{dataset_id}/reuses/{reuse_id} | Retrieve a single reuse based on its ID. |
| GET | /{source}/datasets/{dataset_id}/snapshots | List of all snapshots for this dataset. |
| GET | /{source}/datasets/{dataset_id}/snapshots/{snapshot_id} | List of all snapshots for this dataset. |
| GET | /{source}/exports/csv | Export catalog (source) in CSV format |
| GET | /{source}/exports/json | Export catalog (source) in JSON format |
| GET | /{source}/exports/rdf | Export catalog (source) in RDF/XML format |
| GET | /{source}/exports/rss | Export catalog (source) in RSS format |
| GET | /{source}/exports/ttl | Export catalog (source) in TTL (turtle/rdf) format |
| GET | /{source}/exports/xls | Export catalog (source) in XLS (Excel) format |
| GET | /{source}/facets | Enumerate facets values for datasets and return a list of values for each facet. |
| GET | /{source}/metadata_templates | List of available metadata templates types, each with their endpoints. |
| GET | /{source}/metadata_templates/{metadata_template_type} | List of metadata templates available for this type. |
| GET | /{source}/metadata_templates/{metadata_template_type}/{metadata_template_name} | A single metadata_template |
Questions
Does the opendatasoft API need an API key?
Yes. The opendatasoft API uses API key authentication; the documentation explains how to get credentials.
Does the opendatasoft API support HTTPS?
Yes, the opendatasoft API is served over HTTPS.
How many endpoints does the opendatasoft API have?
Its OpenAPI description lists 36 endpoints in version 2.1.0. All of them are shown on this page.
What are alternatives to the opendatasoft API?
Other Open Data APIs include Search Services, Wayback API, Wikipedia, Nasdaq Data Link, University of Oslo.
Similar open data APIs
Compare alternatives →Search Services
Open DataAPI for Internet Archive's Search-related services
Wayback API
Open DataAPI for Internet Archive's Wayback Machine
Wikipedia
Open DataMediawiki Encyclopedia
Nasdaq Data Link
Open DataThe source for financial, economic, and alternative datasets, serving investment professionals.
University of Oslo
Open DataCourses, lecture videos, detailed information for courses etc. for the University of Oslo (Norway)
Data API
Open DataServes the Clever Data API
Listed from APIs.guru (CC0).