datasets
Dataset related operations
Paramètres de requête
qstringOptionnel
The search query
sortstring · enumOptionnelValeurs possibles:
The field (and direction) on which sorting apply
pageintegerOptionnel
The page to display
page_sizeintegerOptionnel
The page size
tagstring[]Optionnel
licensestringOptionnel
featuredbooleanOptionnel
If set to true, it will filter on featured datasets only. If set to false, it will exclude featured datasets.
geozonestringOptionnel
granularitystringOptionnel
temporal_coveragestringOptionnel
organizationstringOptionnel
organization_badgestring · enumOptionnelValeurs possibles:
ownerstringOptionnel
followed_bystringOptionnel
(beta, subject to change/be removed)
formatstringOptionnel
schemastringOptionnel
schema_versionstringOptionnel
topicstringOptionnel
creditstringOptionnel
dataservicestringOptionnel
reusestringOptionnel
archivedbooleanOptionnel
If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility
deletedbooleanOptionnel
If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility
privatebooleanOptionnel
If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/datasets/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"data": [
{
"acronym": "text",
"archived": "2025-07-30T13:13:23.895Z",
"badges": [
{
"kind": "text"
}
],
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"id": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"role": "text"
}
],
"created_at": "2025-07-30T13:13:23.895Z",
"deleted": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-30T13:13:23.895Z",
"harvest": {
"archived": "text",
"archived_at": "2025-07-30T13:13:23.895Z",
"backend": "text",
"ckan_name": "text",
"ckan_source": "text",
"created_at": "2025-07-30T13:13:23.895Z",
"dct_identifier": "text",
"domain": "text",
"last_update": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"remote_id": "text",
"remote_url": "text",
"source_id": "text",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"last_update": "2025-07-30T13:13:23.895Z",
"license": "notspecified",
"metrics": {},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"page": "text",
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"quality": {},
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-30T13:13:23.895Z",
"start": "2025-07-30T13:13:23.895Z"
},
"title": "text",
"uri": "text"
}
],
"next_page": "text",
"page": 1,
"page_size": 1,
"previous_page": "text",
"total": 1
}Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
acronymstringOptionnel
An optional dataset acronym
archivedstring · date-timeOptionnel
The archival date if archived
created_atstring · date-timeLecture seuleRequis
This date is computed between harvested creation date if any and site's internal creation date
deletedstring · date-timeLecture seuleOptionnel
The deletion date if deleted
descriptionstring · markdownRequis
The dataset description in markdown
extrasobjectOptionnel
Extras attributes as key-value pairs
featuredbooleanOptionnel
Is the dataset featured
frequencystring · enumRequisDefault:
The update frequency
unknownExample: unknownValeurs possibles: frequency_datestring · date-timeOptionnel
Next expected update date, you will be notified once that date is reached.
harvestall ofLecture seuleOptionnel
Dataset harvest metadata attributes
idstringLecture seuleOptionnel
The dataset identifier
internalall ofLecture seuleOptionnel
Site internal and specific object's data
last_modifiedstring · date-timeLecture seuleRequis
The dataset last modification date
last_updatestring · date-timeRequis
The resources last modification date
licensestringOptionnelDefault:
The dataset license
notspecifiedmetricsobjectOptionnel
The dataset metrics
organizationall ofOptionnel
The producer organization
ownerall ofOptionnel
The user information
pagestringLecture seuleOptionnel
The dataset web page URL
privatebooleanOptionnel
Is the dataset private to the owner or the organization
qualityobjectLecture seuleOptionnel
The dataset quality
schemaall ofOptionnel
Reference to the associated schema
slugstringRequis
The dataset permalink string
spatialall ofOptionnel
The spatial coverage
tagsstring[]Optionnel
temporal_coverageall ofOptionnel
The temporal coverage
titlestringRequis
The dataset title
uristringLecture seuleOptionnel
The API URI for this dataset
Réponses
201
Success
application/json
400
Validation error
post
POST /api/1/datasets/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 1922
{
"acronym": "text",
"archived": "2025-07-30T13:13:23.895Z",
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"logo": "text",
"logo_thumbnail": "text",
"slug": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"slug": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"logo": "text",
"logo_thumbnail": "text",
"slug": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"slug": "text"
},
"role": "text"
}
],
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-30T13:13:23.895Z",
"last_update": "2025-07-30T13:13:23.895Z",
"license": "notspecified",
"metrics": {},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"logo": "text",
"logo_thumbnail": "text",
"slug": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"slug": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-30T13:13:23.895Z",
"start": "2025-07-30T13:13:23.895Z"
},
"title": "text"
}{
"acronym": "text",
"archived": "2025-07-30T13:13:23.895Z",
"badges": [
{
"kind": "text"
}
],
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"id": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"role": "text"
}
],
"created_at": "2025-07-30T13:13:23.895Z",
"deleted": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-30T13:13:23.895Z",
"harvest": {
"archived": "text",
"archived_at": "2025-07-30T13:13:23.895Z",
"backend": "text",
"ckan_name": "text",
"ckan_source": "text",
"created_at": "2025-07-30T13:13:23.895Z",
"dct_identifier": "text",
"domain": "text",
"last_update": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"remote_id": "text",
"remote_url": "text",
"source_id": "text",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"last_update": "2025-07-30T13:13:23.895Z",
"license": "notspecified",
"metrics": {},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"page": "text",
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"quality": {},
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-30T13:13:23.895Z",
"start": "2025-07-30T13:13:23.895Z"
},
"title": "text",
"uri": "text"
}Paramètres de requête
sortstringOptionnel
The sorting attribute
pageintegerOptionnel
The page to fetch
page_sizeintegerOptionnel
The page size to fetch
organizationstringOptionnel
Filter activities for that particular organization
datasetstringOptionnel
Filter activities for that particular dataset
ownerstringOptionnel
Filter activities for that particular user
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/datasets/community_resources/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"data": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"next_page": "text",
"page": 1,
"page_size": 1,
"previous_page": "text",
"total": 1
}Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
all ofOptionnel
Réponses
201
Success
application/json
Réponseall of
400
Validation error
post
POST /api/1/datasets/community_resources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 543
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"logo": "text",
"logo_thumbnail": "text",
"slug": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"slug": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}Paramètres de chemin
communityanyRequis
The community resource unique identifier
Paramètres de requête
datasetanyOptionnel
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
Réponseall of
get
GET /api/1/datasets/community_resources/{community}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}Paramètres de chemin
communityanyRequis
The community resource unique identifier
Paramètres de requête
datasetanyOptionnel
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
all ofOptionnel
Réponses
200
Success
application/json
Réponseall of
400
Validation error
put
PUT /api/1/datasets/community_resources/{community}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 543
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"logo": "text",
"logo_thumbnail": "text",
"slug": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"slug": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}Paramètres de chemin
communityanyRequis
The community resource unique identifier
Paramètres de requête
datasetanyOptionnel
The dataset ID or slug
Réponses
200
Success
delete
DELETE /api/1/datasets/community_resources/{community}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
Aucun contenu
Paramètres de chemin
communityanyRequis
The community resource unique identifier
Paramètres de requête
datasetanyOptionnel
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
Réponseall of
400
Upload error
415
Incorrect file content type
post
POST /api/1/datasets/community_resources/{community}/upload/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"success": true
}Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/datasets/licenses/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
[
{
"alternate_titles": [
"text"
],
"alternate_urls": [
"text"
],
"flags": [
"text"
],
"id": "text",
"maintainer": "text",
"title": "text",
"url": "text"
}
]Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/datasets/schemas/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
[
{
"consolidation_dataset_id": "text",
"contact": "text",
"datapackage_description": "text",
"datapackage_name": "text",
"datapackage_title": "text",
"description": "text",
"examples": [
{
"path": "text",
"title": "text"
}
],
"external_doc": "text",
"external_tool": "text",
"homepage": "text",
"labels": [
"text"
],
"name": "text",
"schema_type": "tableschema",
"schema_url": "text",
"title": "text",
"versions": [
{
"schema_url": "text",
"version_name": "text"
}
]
}
]Paramètres de requête
qstringRequis
The string to autocomplete/suggest
sizeintegerOptionnel
The amount of suggestion to fetch
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/datasets/suggest/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"acronym": "text",
"id": "text",
"image_url": "text",
"page": "text",
"slug": "text",
"title": "text"
}Paramètres de chemin
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
404
Dataset not found
410
Dataset has been deleted
get
GET /api/1/datasets/{dataset}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
{
"acronym": "text",
"archived": "2025-07-30T13:13:23.895Z",
"badges": [
{
"kind": "text"
}
],
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"id": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"role": "text"
}
],
"created_at": "2025-07-30T13:13:23.895Z",
"deleted": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-30T13:13:23.895Z",
"harvest": {
"archived": "text",
"archived_at": "2025-07-30T13:13:23.895Z",
"backend": "text",
"ckan_name": "text",
"ckan_source": "text",
"created_at": "2025-07-30T13:13:23.895Z",
"dct_identifier": "text",
"domain": "text",
"last_update": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"remote_id": "text",
"remote_url": "text",
"source_id": "text",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"last_update": "2025-07-30T13:13:23.895Z",
"license": "notspecified",
"metrics": {},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"page": "text",
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"quality": {},
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-30T13:13:23.895Z",
"start": "2025-07-30T13:13:23.895Z"
},
"title": "text",
"uri": "text"
}Paramètres de chemin
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
acronymstringOptionnel
An optional dataset acronym
archivedstring · date-timeOptionnel
The archival date if archived
created_atstring · date-timeLecture seuleRequis
This date is computed between harvested creation date if any and site's internal creation date
deletedstring · date-timeLecture seuleOptionnel
The deletion date if deleted
descriptionstring · markdownRequis
The dataset description in markdown
extrasobjectOptionnel
Extras attributes as key-value pairs
featuredbooleanOptionnel
Is the dataset featured
frequencystring · enumRequisDefault:
The update frequency
unknownExample: unknownValeurs possibles: frequency_datestring · date-timeOptionnel
Next expected update date, you will be notified once that date is reached.
harvestall ofLecture seuleOptionnel
Dataset harvest metadata attributes
idstringLecture seuleOptionnel
The dataset identifier
internalall ofLecture seuleOptionnel
Site internal and specific object's data
last_modifiedstring · date-timeLecture seuleRequis
The dataset last modification date
last_updatestring · date-timeRequis
The resources last modification date
licensestringOptionnelDefault:
The dataset license
notspecifiedmetricsobjectOptionnel
The dataset metrics
organizationall ofOptionnel
The producer organization
ownerall ofOptionnel
The user information
pagestringLecture seuleOptionnel
The dataset web page URL
privatebooleanOptionnel
Is the dataset private to the owner or the organization
qualityobjectLecture seuleOptionnel
The dataset quality
schemaall ofOptionnel
Reference to the associated schema
slugstringRequis
The dataset permalink string
spatialall ofOptionnel
The spatial coverage
tagsstring[]Optionnel
temporal_coverageall ofOptionnel
The temporal coverage
titlestringRequis
The dataset title
uristringLecture seuleOptionnel
The API URI for this dataset
Réponses
200
Success
application/json
400
Validation error: your data cannot be updated for now, we have been notified of the error and we will fix it as soon as possible.
404
Dataset not found
410
Dataset has been deleted
put
PUT /api/1/datasets/{dataset}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 1922
{
"acronym": "text",
"archived": "2025-07-30T13:13:23.895Z",
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"logo": "text",
"logo_thumbnail": "text",
"slug": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"slug": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"logo": "text",
"logo_thumbnail": "text",
"slug": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"slug": "text"
},
"role": "text"
}
],
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-30T13:13:23.895Z",
"last_update": "2025-07-30T13:13:23.895Z",
"license": "notspecified",
"metrics": {},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"logo": "text",
"logo_thumbnail": "text",
"slug": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"slug": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-30T13:13:23.895Z",
"start": "2025-07-30T13:13:23.895Z"
},
"title": "text"
}{
"acronym": "text",
"archived": "2025-07-30T13:13:23.895Z",
"badges": [
{
"kind": "text"
}
],
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"id": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"role": "text"
}
],
"created_at": "2025-07-30T13:13:23.895Z",
"deleted": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-30T13:13:23.895Z",
"harvest": {
"archived": "text",
"archived_at": "2025-07-30T13:13:23.895Z",
"backend": "text",
"ckan_name": "text",
"ckan_source": "text",
"created_at": "2025-07-30T13:13:23.895Z",
"dct_identifier": "text",
"domain": "text",
"last_update": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"remote_id": "text",
"remote_url": "text",
"source_id": "text",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"last_update": "2025-07-30T13:13:23.895Z",
"license": "notspecified",
"metrics": {},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"page": "text",
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"quality": {},
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-30T13:13:23.895Z",
"start": "2025-07-30T13:13:23.895Z"
},
"title": "text",
"uri": "text"
}Paramètres de chemin
datasetstringRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
kindstringRequis
Kind of badge (certified, etc), specific to each model
Réponses
200
Success
application/json
post
POST /api/1/datasets/{dataset}/badges/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"kind": "text"
}200
Success
{
"kind": "text"
}Paramètres de chemin
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
post
POST /api/1/datasets/{dataset}/featured/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"acronym": "text",
"archived": "2025-07-30T13:13:23.895Z",
"badges": [
{
"kind": "text"
}
],
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"id": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"role": "text"
}
],
"created_at": "2025-07-30T13:13:23.895Z",
"deleted": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-30T13:13:23.895Z",
"harvest": {
"archived": "text",
"archived_at": "2025-07-30T13:13:23.895Z",
"backend": "text",
"ckan_name": "text",
"ckan_source": "text",
"created_at": "2025-07-30T13:13:23.895Z",
"dct_identifier": "text",
"domain": "text",
"last_update": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"remote_id": "text",
"remote_url": "text",
"source_id": "text",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"last_update": "2025-07-30T13:13:23.895Z",
"license": "notspecified",
"metrics": {},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"page": "text",
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"quality": {},
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-30T13:13:23.895Z",
"start": "2025-07-30T13:13:23.895Z"
},
"title": "text",
"uri": "text"
}Paramètres de chemin
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
delete
DELETE /api/1/datasets/{dataset}/featured/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"acronym": "text",
"archived": "2025-07-30T13:13:23.895Z",
"badges": [
{
"kind": "text"
}
],
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"id": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"role": "text"
}
],
"created_at": "2025-07-30T13:13:23.895Z",
"deleted": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-30T13:13:23.895Z",
"harvest": {
"archived": "text",
"archived_at": "2025-07-30T13:13:23.895Z",
"backend": "text",
"ckan_name": "text",
"ckan_source": "text",
"created_at": "2025-07-30T13:13:23.895Z",
"dct_identifier": "text",
"domain": "text",
"last_update": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"remote_id": "text",
"remote_url": "text",
"source_id": "text",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"last_update": "2025-07-30T13:13:23.895Z",
"license": "notspecified",
"metrics": {},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"page": "text",
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"quality": {},
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-30T13:13:23.895Z",
"start": "2025-07-30T13:13:23.895Z"
},
"title": "text",
"uri": "text"
}get
Paramètres de chemin
datasetanyRequis
The dataset ID or slug
Réponses
404
Dataset not found
410
Dataset has been deleted
get
GET /api/1/datasets/{dataset}/rdf HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
Aucun contenu
get
Paramètres de chemin
datasetanyRequis
The dataset ID or slug
formatanyRequis
Réponses
404
Dataset not found
410
Dataset has been deleted
get
GET /api/1/datasets/{dataset}/rdf.{format} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
Aucun contenu
Paramètres de chemin
datasetstringRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
checksumall ofOptionnel
A checksum to validate file validity
created_atstring · date-timeLecture seuleOptionnel
The resource creation date
descriptionstring · markdownOptionnel
The resource markdown description
extrasobjectOptionnel
Extra attributes as key-value pairs
filesizeintegerOptionnel
The resource file size in bytes
filetypestring · enumRequisExample:
Whether the resource is an uploaded file, a remote file or an API
fileValeurs possibles: formatstringRequis
The resource format
harvestall ofLecture seuleOptionnel
Harvest attributes metadata information
idstringLecture seuleOptionnel
The resource unique ID
internalall ofLecture seuleOptionnel
Site internal and specific object's data
last_modifiedstring · date-timeLecture seuleOptionnel
The resource last modification date
lateststringLecture seuleOptionnel
The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.
metricsobjectLecture seuleOptionnel
The resource metrics
mimestringOptionnel
The resource mime type
preview_urlstringLecture seuleOptionnel
An optional preview URL to be loaded as a standalone page (ie. iframe or new page)
schemaall ofOptionnel
Reference to the associated schema
titlestringRequis
The resource title
typestring · enumRequisExample:
Resource type (documentation, API...)
mainValeurs possibles: urlstringRequis
The resource URL
Réponses
201
Success
application/json
400
Validation error
post
POST /api/1/datasets/{dataset}/resources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 234
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}Paramètres de chemin
datasetstringRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corpsobject[]
checksumall ofOptionnel
A checksum to validate file validity
created_atstring · date-timeLecture seuleOptionnel
The resource creation date
descriptionstring · markdownOptionnel
The resource markdown description
extrasobjectOptionnel
Extra attributes as key-value pairs
filesizeintegerOptionnel
The resource file size in bytes
filetypestring · enumRequisExample:
Whether the resource is an uploaded file, a remote file or an API
fileValeurs possibles: formatstringRequis
The resource format
harvestall ofLecture seuleOptionnel
Harvest attributes metadata information
idstringLecture seuleOptionnel
The resource unique ID
internalall ofLecture seuleOptionnel
Site internal and specific object's data
last_modifiedstring · date-timeLecture seuleOptionnel
The resource last modification date
lateststringLecture seuleOptionnel
The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.
metricsobjectLecture seuleOptionnel
The resource metrics
mimestringOptionnel
The resource mime type
preview_urlstringLecture seuleOptionnel
An optional preview URL to be loaded as a standalone page (ie. iframe or new page)
schemaall ofOptionnel
Reference to the associated schema
titlestringRequis
The resource title
typestring · enumRequisExample:
Resource type (documentation, API...)
mainValeurs possibles: urlstringRequis
The resource URL
Réponses
200
Success
application/json
400
Validation error
put
PUT /api/1/datasets/{dataset}/resources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 236
[
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
][
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
]Paramètres de chemin
ridanyRequis
The resource unique identifier
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/datasets/{dataset}/resources/{rid}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}Paramètres de chemin
ridanyRequis
The resource unique identifier
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
checksumall ofOptionnel
A checksum to validate file validity
created_atstring · date-timeLecture seuleOptionnel
The resource creation date
descriptionstring · markdownOptionnel
The resource markdown description
extrasobjectOptionnel
Extra attributes as key-value pairs
filesizeintegerOptionnel
The resource file size in bytes
filetypestring · enumRequisExample:
Whether the resource is an uploaded file, a remote file or an API
fileValeurs possibles: formatstringRequis
The resource format
harvestall ofLecture seuleOptionnel
Harvest attributes metadata information
idstringLecture seuleOptionnel
The resource unique ID
internalall ofLecture seuleOptionnel
Site internal and specific object's data
last_modifiedstring · date-timeLecture seuleOptionnel
The resource last modification date
lateststringLecture seuleOptionnel
The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.
metricsobjectLecture seuleOptionnel
The resource metrics
mimestringOptionnel
The resource mime type
preview_urlstringLecture seuleOptionnel
An optional preview URL to be loaded as a standalone page (ie. iframe or new page)
schemaall ofOptionnel
Reference to the associated schema
titlestringRequis
The resource title
typestring · enumRequisExample:
Resource type (documentation, API...)
mainValeurs possibles: urlstringRequis
The resource URL
Réponses
200
Success
application/json
400
Validation error
put
PUT /api/1/datasets/{dataset}/resources/{rid}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 234
{
"checksum": {
"type": "sha1",
"value": "text"
},
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"mime": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}Paramètres de chemin
ridanyRequis
The resource unique identifier
datasetanyRequis
The dataset ID or slug
Réponses
200
Success
get
GET /api/1/datasets/{dataset}/resources/{rid}/check/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
Aucun contenu
Paramètres de chemin
ridanyRequis
The resource unique identifier
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
Réponseall of
400
Upload error
415
Incorrect file content type
post
POST /api/1/datasets/{dataset}/resources/{rid}/upload/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"success": true
}Paramètres de chemin
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
filestringOptionnel
uuidstringOptionnel
filenamestringOptionnel
partindexintegerOptionnel
partbyteoffsetintegerOptionnel
totalpartsintegerOptionnel
chunksizeintegerOptionnel
Réponses
201
Success
application/json
Réponseall of
400
Upload error
415
Incorrect file content type
post
POST /api/1/datasets/{dataset}/upload/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 109
"file='text'&uuid='text'&filename='text'&partindex=1&partbyteoffset=1&totalparts=1&chunksize=1"{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"success": true
}Paramètres de chemin
datasetanyRequis
The dataset ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
filestringOptionnel
uuidstringOptionnel
filenamestringOptionnel
partindexintegerOptionnel
partbyteoffsetintegerOptionnel
totalpartsintegerOptionnel
chunksizeintegerOptionnel
Réponses
201
Success
application/json
Réponseall of
400
Upload error
415
Incorrect file content type
post
POST /api/1/datasets/{dataset}/upload/community/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 109
"file='text'&uuid='text'&filename='text'&partindex=1&partbyteoffset=1&totalparts=1&chunksize=1"{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-30T13:13:23.895Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-30T13:13:23.895Z",
"modified_at": "2025-07-30T13:13:23.895Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-30T13:13:23.895Z",
"last_modified_internal": "2025-07-30T13:13:23.895Z"
},
"last_modified": "2025-07-30T13:13:23.895Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text",
"dataset": {
"class": "text",
"id": "text",
"acronym": "text",
"page": "text",
"title": "text",
"uri": "text"
},
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"owner": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"success": true
}Paramètres de chemin
idanyRequis
Paramètres de requête
pageintegerOptionnel
The page to fetch
page_sizeintegerOptionnel
The page size to fetch
userstringOptionnel
Filter follower by user, it allows to check if a user is following the object
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/datasets/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"data": [
{
"follower": {
"class": "text",
"id": "text",
"avatar": "text",
"avatar_thumbnail": "text",
"first_name": "text",
"last_name": "text",
"page": "text",
"slug": "text",
"uri": "text"
},
"id": "text",
"since": "2025-07-30T13:13:23.895Z"
}
],
"next_page": "text",
"page": 1,
"page_size": 1,
"previous_page": "text",
"total": 1
}Mis à jour
Ce contenu vous a-t-il été utile ?