{"@context": "https://schema.org", "@type": "WebAPI", "name": "opendatasoft API", "description": "opendatasoft, an HTTP API described by an OpenAPI document.", "provider": {"@type": "Organization", "name": "opendatasoft.com"}, "documentation": "http://public.opendatasoft.com/api/v2/swagger.json"}
opendatasoft, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://public.opendatasoft.com/api/v2
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
opendatasoft, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | API entry point Provides links for: * catalog, your domain's list of datasets * opendatasoft, all datasets on |
GET | /pages | List of all pages from this portal. page ods |
GET | /pages/{slug} | A single page's metadata from this portal page ods |
GET | /{source} | Source entry points Provides links for the source's datasets and metadata. catalog ods |
GET | /{source}/aggregates | **Deprecated, use `/datasets` instead.** catalog aggregations ods |
GET | /{source}/datasets | List of available datasets, each with their endpoints, paginated. Links provided: * previous page * next page |
GET | /{source}/datasets/{dataset_id} | List of available endpoints for the specified dataset, with metadata and endpoints. Will provide links for: * |
GET | /{source}/datasets/{dataset_id}/aggregates | **Deprecated, use `/records` instead.** dataset aggregations ods |
GET | /{source}/datasets/{dataset_id}/attachments | Get list of all available attachments dataset ods |
GET | /{source}/datasets/{dataset_id}/attachments/{attachment_id} | Download attachment dataset ods |
GET | /{source}/datasets/{dataset_id}/exports/csv | Export dataset in CSV format export dataset ods |
GET | /{source}/datasets/{dataset_id}/exports/geojson | Export dataset in GEOJSON format export dataset ods |
GET | /{source}/datasets/{dataset_id}/exports/ical | Export dataset in ICAL format export dataset ods |
GET | /{source}/datasets/{dataset_id}/exports/json | Export dataset in JSON format export dataset ods |
GET | /{source}/datasets/{dataset_id}/exports/ov2 | Export dataset in OV2 format export dataset ods |
GET | /{source}/datasets/{dataset_id}/exports/shp | Export dataset in Esri shapefile (shp) format export dataset ods |
GET | /{source}/datasets/{dataset_id}/exports/xls | Export dataset in XLS (Excel) format export dataset ods |
GET | /{source}/datasets/{dataset_id}/facets | Enumerate facets values for records and return a list of values for each facet. Can be used to implement guide |
PUT | /{source}/datasets/{dataset_id}/feedback | Create new feedback entry. dataset ods |
GET | /{source}/datasets/{dataset_id}/files/{file_id} | Download file dataset ods |
GET | /{source}/datasets/{dataset_id}/records | Search dataset's records. dataset ods |
GET | /{source}/datasets/{dataset_id}/records/{record_id} | Retrieve a single record based on its ID. dataset ods |
GET | /{source}/datasets/{dataset_id}/reuses | Get list of reuses dataset ods |
GET | /{source}/datasets/{dataset_id}/reuses/{reuse_id} | Retrieve a single reuse based on its ID. dataset ods |
GET | /{source}/datasets/{dataset_id}/snapshots | List of all snapshots for this dataset. dataset ods |
GET | /{source}/datasets/{dataset_id}/snapshots/{snapshot_id} | List of all snapshots for this dataset. dataset ods |
GET | /{source}/exports/csv | Export catalog (source) in CSV format export catalog ods |
GET | /{source}/exports/json | Export catalog (source) in JSON format export catalog ods |
GET | /{source}/exports/rdf | Export catalog (source) in RDF/XML format export catalog ods |
GET | /{source}/exports/rss | Export catalog (source) in RSS format export catalog ods |
GET | /{source}/exports/ttl | Export catalog (source) in TTL (turtle/rdf) format export catalog ods |
GET | /{source}/exports/xls | Export catalog (source) in XLS (Excel) format export catalog ods |
GET | /{source}/facets | Enumerate facets values for datasets and return a list of values for each facet. Can be used to implement guid |
GET | /{source}/metadata_templates | List of available metadata templates types, each with their endpoints. metadata ods |
GET | /{source}/metadata_templates/{metadata_template_type} | List of metadata templates available for this type. metadata ods |
GET | /{source}/metadata_templates/{metadata_template_type}/{metadata_template_name} | A single metadata_template metadata ods |
specification origin: http://public.opendatasoft.com/api/v2/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.