# opendatasoft API

> opendatasoft API on Apizie: 36 endpoints (API entry point Provides links for: * catalog, your domain's list of datasets * opendatasoft, all datasets…, List of all pages from this portal., A single page's metadata from this portal, Source entry points Provides links for the source's datasets and metadata., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/open-data:opendatasoft/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:opendatasoft`
- Category: Open Data
- Status: byok
- Source: https://opendatasoft.com
- Page: https://apizie.tech/api/open-data/opendatasoft
- OpenAPI: https://apizie.tech/api/open-data/opendatasoft/openapi.json



## Endpoints

### API entry point Provides links for: * catalog, your domain's list of datasets * opendatasoft, all datasets…
`GET https://apizie.tech/v1/open-data:opendatasoft/get-root` (byok)

### List of all pages from this portal.
`GET https://apizie.tech/v1/open-data:opendatasoft/get-pages` (byok)

### A single page's metadata from this portal
`GET https://apizie.tech/v1/open-data:opendatasoft/get-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | string | yes | Page slug. |

### Source entry points Provides links for the source's datasets and metadata.
`GET https://apizie.tech/v1/open-data:opendatasoft/get-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |

### **Deprecated, use `/datasets` instead.**
`GET https://apizie.tech/v1/open-data:opendatasoft/aggregate-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| group_by | string | no | A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |

### List of available datasets, each with their endpoints, paginated. Links provided: * previous page * next…
`GET https://apizie.tech/v1/open-data:opendatasoft/get-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| group_by | string | no | A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| pretty | boolean | no | Activate pretty print |
| timezone | string | no | Set timezone for datetime fields |
| include_app_metas | boolean | no | Explicitely request application metas for each datasets. |

### List of available endpoints for the specified dataset, with metadata and endpoints. Will provide links for:…
`GET https://apizie.tech/v1/open-data:opendatasoft/get-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| pretty | boolean | no | Activate pretty print |
| timezone | string | no | Set timezone for datetime fields |
| include_app_metas | boolean | no | Explicitely request application metas for each datasets. |

### **Deprecated, use `/records` instead.**
`GET https://apizie.tech/v1/open-data:opendatasoft/aggregate-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| group_by | string | no | A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |

### Get list of all available attachments
`GET https://apizie.tech/v1/open-data:opendatasoft/get-dataset-attachements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |

### Download attachment
`GET https://apizie.tech/v1/open-data:opendatasoft/download-dataset-attachement` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| attachment_id | string | yes |  |

### Export dataset in CSV format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-records-csv` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return in export. Use -1 (default) to retrieve all records |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |
| delimiter | string | no | Provide a different delimiter (default ','). |

### Export dataset in GEOJSON format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-records-geojson` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return in export. Use -1 (default) to retrieve all records |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |
| pretty | boolean | no | Activate pretty print |

### Export dataset in ICAL format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-records-ical` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return in export. Use -1 (default) to retrieve all records |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |

### Export dataset in JSON format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-records-json` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return in export. Use -1 (default) to retrieve all records |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| pretty | boolean | no | Activate pretty print |
| timezone | string | no | Set timezone for datetime fields |

### Export dataset in OV2 format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-records-ov2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return in export. Use -1 (default) to retrieve all records |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |

### Export dataset in Esri shapefile (shp) format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-records-shp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return in export. Use -1 (default) to retrieve all records |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |

### Export dataset in XLS (Excel) format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-records-xls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return in export. Use -1 (default) to retrieve all records |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |

### Enumerate facets values for records and return a list of values for each facet. Can be used to implement…
`GET https://apizie.tech/v1/open-data:opendatasoft/get-records-facets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| timezone | string | no | Set timezone for datetime fields |

### Create new feedback entry.
`POST https://apizie.tech/v1/open-data:opendatasoft/send-dataset-feedback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| body | object | yes | JSON request body |

### Download file
`GET https://apizie.tech/v1/open-data:opendatasoft/get-dataset-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| file_id | string | yes |  |
| thumbnail_size | string | no | Set the size of the thumbnail representing the resource (attachment, image or file) |

### Search dataset's records.
`GET https://apizie.tech/v1/open-data:opendatasoft/get-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| group_by | string | no | A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field… |
| sort | array | no | **Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the… |
| order_by | array | no | A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| pretty | boolean | no | Activate pretty print |
| timezone | string | no | Set timezone for datetime fields |

### Retrieve a single record based on its ID.
`GET https://apizie.tech/v1/open-data:opendatasoft/get-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| record_id | string | yes |  |
| select | string | no | A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a… |
| pretty | boolean | no | Activate pretty print |
| timezone | string | no | Set timezone for datetime fields |

### Get list of reuses
`GET https://apizie.tech/v1/open-data:opendatasoft/get-dataset-reuses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| timezone | string | no | Set timezone for datetime fields |

### Retrieve a single reuse based on its ID.
`GET https://apizie.tech/v1/open-data:opendatasoft/get-dataset-reuse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| reuse_id | string | yes |  |
| timezone | string | no | Set timezone for datetime fields |

### List of all snapshots for this dataset.
`GET https://apizie.tech/v1/open-data:opendatasoft/get-dataset-snapshots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| timezone | string | no | Set timezone for datetime fields |

### List of all snapshots for this dataset.
`GET https://apizie.tech/v1/open-data:opendatasoft/download-dataset-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| dataset_id | string | yes | Dataset identifier. Can be found in the "information" tab of the dataset page. |
| snapshot_id | string | yes |  |
| timezone | string | no | Set timezone for datetime fields |

### Export catalog (source) in CSV format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-datasets-csv` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |
| include_app_metas | boolean | no | Explicitely request application metas for each datasets. |
| delimiter | string | no | Provide a different delimiter (default ','). |

### Export catalog (source) in JSON format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-datasets-json` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| pretty | boolean | no | Activate pretty print |
| timezone | string | no | Set timezone for datetime fields |
| include_app_metas | boolean | no | Explicitely request application metas for each datasets. |

### Export catalog (source) in RDF/XML format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-datasets-rdf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |
| include_app_metas | boolean | no | Explicitely request application metas for each datasets. |

### Export catalog (source) in RSS format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-datasets-rss` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |
| include_app_metas | boolean | no | Explicitely request application metas for each datasets. |

### Export catalog (source) in TTL (turtle/rdf) format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-datasets-ttl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |
| include_app_metas | boolean | no | Explicitely request application metas for each datasets. |

### Export catalog (source) in XLS (Excel) format
`GET https://apizie.tech/v1/open-data:opendatasoft/export-datasets-xls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| limit | integer | no | Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use… |
| offset | integer | no | Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination. |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| timezone | string | no | Set timezone for datetime fields |
| include_app_metas | boolean | no | Explicitely request application metas for each datasets. |

### Enumerate facets values for datasets and return a list of values for each facet. Can be used to implement…
`GET https://apizie.tech/v1/open-data:opendatasoft/get-datasets-facets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| facet | array | no | A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).… |
| refine | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.… |
| exclude | array | no | An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read… |
| where | array | no | An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,… |
| search | array | no | An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a… |
| timezone | string | no | Set timezone for datetime fields |

### List of available metadata templates types, each with their endpoints.
`GET https://apizie.tech/v1/open-data:opendatasoft/get-metadata-templates-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |

### List of metadata templates available for this type.
`GET https://apizie.tech/v1/open-data:opendatasoft/get-metadata-templates-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| metadata_template_type | string | yes |  |

### A single metadata_template
`GET https://apizie.tech/v1/open-data:opendatasoft/get-metadata-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of… |
| metadata_template_type | string | yes |  |
| metadata_template_name | string | yes |  |

## Example
```
curl "https://apizie.tech/v1/open-data:opendatasoft/get-root" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the opendatasoft API?
Create a free Apizie key, then send GET https://apizie.tech/v1/open-data:opendatasoft/get-root with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the opendatasoft API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. opendatasoft itself also needs your own key from opendatasoft.com.

### Can AI agents use the opendatasoft API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:opendatasoft.

### What is the status of the opendatasoft API?
Needs your own provider key (bring your own key)