{"@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"}
Index / APIs / opendatasoft.com

opendatasoft API

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 v2.1.0

opendatasoft, an HTTP API described by an OpenAPI document.

methodpathwhat the vendor says it does
GET/API entry point Provides links for: * catalog, your domain's list of datasets * opendatasoft, all datasets on
GET/pagesList 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}/datasetsList 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}/attachmentsGet 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/csvExport dataset in CSV format export dataset ods
GET/{source}/datasets/{dataset_id}/exports/geojsonExport dataset in GEOJSON format export dataset ods
GET/{source}/datasets/{dataset_id}/exports/icalExport dataset in ICAL format export dataset ods
GET/{source}/datasets/{dataset_id}/exports/jsonExport dataset in JSON format export dataset ods
GET/{source}/datasets/{dataset_id}/exports/ov2Export dataset in OV2 format export dataset ods
GET/{source}/datasets/{dataset_id}/exports/shpExport dataset in Esri shapefile (shp) format export dataset ods
GET/{source}/datasets/{dataset_id}/exports/xlsExport dataset in XLS (Excel) format export dataset ods
GET/{source}/datasets/{dataset_id}/facetsEnumerate facets values for records and return a list of values for each facet. Can be used to implement guide
PUT/{source}/datasets/{dataset_id}/feedbackCreate new feedback entry. dataset ods
GET/{source}/datasets/{dataset_id}/files/{file_id}Download file dataset ods
GET/{source}/datasets/{dataset_id}/recordsSearch 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}/reusesGet 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}/snapshotsList 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/csvExport catalog (source) in CSV format export catalog ods
GET/{source}/exports/jsonExport catalog (source) in JSON format export catalog ods
GET/{source}/exports/rdfExport catalog (source) in RDF/XML format export catalog ods
GET/{source}/exports/rssExport catalog (source) in RSS format export catalog ods
GET/{source}/exports/ttlExport catalog (source) in TTL (turtle/rdf) format export catalog ods
GET/{source}/exports/xlsExport catalog (source) in XLS (Excel) format export catalog ods
GET/{source}/facetsEnumerate facets values for datasets and return a list of values for each facet. Can be used to implement guid
GET/{source}/metadata_templatesList 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.