✉️ Contact💬 Forum

datasets

Dataset related operations

List or search all datasets

get
Query parameters
qanyoptional

The search query

sortanyoptional

The field (and direction) on which sorting apply

pageanyoptional

The page to display

page_sizeanyoptional

The page size

taganyoptional
licenseanyoptional
featuredanyoptional
geozoneanyoptional
granularityanyoptional
temporal_coverageanyoptional
organizationanyoptional
organization_badgeanyoptional
owneranyoptional
formatanyoptional
schemaanyoptional
schema_versionanyoptional
topicanyoptional
creditanyoptional
dataserviceanyoptional
Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/'
{
  "data": [
    {
      "acronym": "text",
      "archived": "2025-03-25T05:00:16.425Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2025-03-25T05:00:16.425Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2025-03-25T05:00:16.425Z",
            "modified_at": "2025-03-25T05:00:16.425Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2025-03-25T05:00:16.425Z",
            "last_modified_internal": "2025-03-25T05:00:16.425Z"
          },
          "last_modified": "2025-03-25T05:00:16.425Z",
          "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"
          }
        }
      ],
      "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-03-25T05:00:16.425Z",
      "deleted": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "featured": true,
      "frequency": "unknown",
      "frequency_date": "2025-03-25T05:00:16.425Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2025-03-25T05:00:16.425Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2025-03-25T05:00:16.425Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "last_update": "2025-03-25T05:00:16.425Z",
      "license": "text",
      "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",
      "private": true,
      "quality": {},
      "resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2025-03-25T05:00:16.425Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2025-03-25T05:00:16.425Z",
            "modified_at": "2025-03-25T05:00:16.425Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2025-03-25T05:00:16.425Z",
            "last_modified_internal": "2025-03-25T05:00:16.425Z"
          },
          "last_modified": "2025-03-25T05:00:16.425Z",
          "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": "text",
        "zones": [
          "text"
        ]
      },
      "tags": [
        "text"
      ],
      "temporal_coverage": {
        "end": "2025-03-25T05:00:16.425Z",
        "start": "2025-03-25T05:00:16.425Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Success

Create a new dataset

post
Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
acronymstringoptional

An optional dataset acronym

archivedstring · date-timeoptional

The archival date if archived

badgesobject[]read-onlyoptional

The dataset badges

community_resourcesall of[]optional

The dataset community submitted resources

contact_pointsall of[]optional

The dataset contact points

created_atstring · date-timeread-onlyrequired

This date is computed between harvested creation date if any and site's internal creation date

deletedstring · date-timeread-onlyoptional

The deletion date if deleted

descriptionstring · markdownrequired

The dataset description in markdown

extrasobjectoptional

Extras attributes as key-value pairs

featuredbooleanoptional

Is the dataset featured

frequencystring · enum · default: "unknown"required

The update frequency

Example: unknown
Options: unknown, punctual, continuous, hourly, fourTimesADay, threeTimesADay, semidaily, daily, fourTimesAWeek, threeTimesAWeek, semiweekly, weekly, biweekly, threeTimesAMonth, semimonthly, monthly, bimonthly, quarterly, threeTimesAYear, semiannual, annual, biennial, triennial, quinquennial, irregular
frequency_datestring · date-timeoptional

Next expected update date, you will be notified once that date is reached.

harvestall ofread-onlyoptional

Dataset harvest metadata attributes

idstringread-onlyoptional

The dataset identifier

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyrequired

The dataset last modification date

last_updatestring · date-timerequired

The resources last modification date

licensestring · default: "notspecified"optional

The dataset license

metricsobjectoptional

The dataset metrics

organizationall ofoptional

The producer organization

ownerall ofoptional

The user information

pagestringrequired

The dataset page URL

privatebooleanoptional

Is the dataset private to the owner or the organization

qualityobjectread-onlyoptional

The dataset quality

resourcesall of[]optional

The dataset resources

schemaall ofoptional

Reference to the associated schema

slugstringrequired

The dataset permalink string

spatialall ofoptional

The spatial coverage

tagsstring[]optional
temporal_coverageall ofoptional

The temporal coverage

titlestringrequired

The dataset title

uristringrequired

The dataset API URI

Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/' \
  --header 'Content-Type: application/json' \
  --data '{
    "acronym": "text",
    "archived": "2025-03-25T05:00:16.425Z",
    "community_resources": [
      {
        "checksum": {
          "type": "sha1",
          "value": "text"
        },
        "created_at": "2025-03-25T05:00:16.425Z",
        "description": "text",
        "extras": {},
        "filesize": 1,
        "filetype": "file",
        "format": "text",
        "harvest": {
          "created_at": "2025-03-25T05:00:16.425Z",
          "modified_at": "2025-03-25T05:00:16.425Z",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-03-25T05:00:16.425Z",
          "last_modified_internal": "2025-03-25T05:00:16.425Z"
        },
        "last_modified": "2025-03-25T05:00:16.425Z",
        "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"
        }
      }
    ],
    "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"
      }
    ],
    "description": "text",
    "extras": {},
    "featured": true,
    "frequency": "unknown",
    "frequency_date": "2025-03-25T05:00:16.425Z",
    "harvest": {
      "archived": "text",
      "archived_at": "2025-03-25T05:00:16.425Z",
      "backend": "text",
      "ckan_name": "text",
      "ckan_source": "text",
      "created_at": "2025-03-25T05:00:16.425Z",
      "dct_identifier": "text",
      "domain": "text",
      "last_update": "2025-03-25T05:00:16.425Z",
      "modified_at": "2025-03-25T05:00:16.425Z",
      "remote_id": "text",
      "remote_url": "text",
      "source_id": "text",
      "uri": "text"
    },
    "internal": {
      "created_at_internal": "2025-03-25T05:00:16.425Z",
      "last_modified_internal": "2025-03-25T05:00:16.425Z"
    },
    "last_update": "2025-03-25T05:00:16.425Z",
    "license": "text",
    "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",
    "private": true,
    "quality": {},
    "resources": [
      {
        "checksum": {
          "type": "sha1",
          "value": "text"
        },
        "created_at": "2025-03-25T05:00:16.425Z",
        "description": "text",
        "extras": {},
        "filesize": 1,
        "filetype": "file",
        "format": "text",
        "harvest": {
          "created_at": "2025-03-25T05:00:16.425Z",
          "modified_at": "2025-03-25T05:00:16.425Z",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-03-25T05:00:16.425Z",
          "last_modified_internal": "2025-03-25T05:00:16.425Z"
        },
        "last_modified": "2025-03-25T05:00:16.425Z",
        "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": "text",
      "zones": [
        "text"
      ]
    },
    "tags": [
      "text"
    ],
    "temporal_coverage": {
      "end": "2025-03-25T05:00:16.425Z",
      "start": "2025-03-25T05:00:16.425Z"
    },
    "title": "text",
    "uri": "text"
  }'
{
  "acronym": "text",
  "archived": "2025-03-25T05:00:16.425Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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"
      }
    }
  ],
  "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-03-25T05:00:16.425Z",
  "deleted": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-03-25T05:00:16.425Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-03-25T05:00:16.425Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-03-25T05:00:16.425Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "last_update": "2025-03-25T05:00:16.425Z",
  "license": "text",
  "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",
  "private": true,
  "quality": {},
  "resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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": "text",
    "zones": [
      "text"
    ]
  },
  "tags": [
    "text"
  ],
  "temporal_coverage": {
    "end": "2025-03-25T05:00:16.425Z",
    "start": "2025-03-25T05:00:16.425Z"
  },
  "title": "text",
  "uri": "text"
}

Success

List all available dataset badges and their labels

get
Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/badges/'
No body

Success

List all community resources

get
Query parameters
sortanyoptional

The sorting attribute

pageanyoptional

The page to fetch

page_sizeanyoptional

The page size to fetch

organizationanyoptional

Filter activities for that particular organization

datasetanyoptional

Filter activities for that particular dataset

owneranyoptional

Filter activities for that particular user

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/community_resources/'
{
  "data": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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"
      }
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Success

Create a new community resource

post
Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
all ofoptional

Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/community_resources/' \
  --header 'Content-Type: application/json' \
  --data '{
    "checksum": {
      "type": "sha1",
      "value": "text"
    },
    "created_at": "2025-03-25T05:00:16.425Z",
    "description": "text",
    "extras": {},
    "filesize": 1,
    "filetype": "file",
    "format": "text",
    "harvest": {
      "created_at": "2025-03-25T05:00:16.425Z",
      "modified_at": "2025-03-25T05:00:16.425Z",
      "uri": "text"
    },
    "id": "text",
    "internal": {
      "created_at_internal": "2025-03-25T05:00:16.425Z",
      "last_modified_internal": "2025-03-25T05:00:16.425Z"
    },
    "last_modified": "2025-03-25T05:00:16.425Z",
    "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"
    }
  }'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "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"
  }
}

Success

Retrieve a community resource given its identifier

get
Path parameters
communityanyrequired

The community resource unique identifier

Query parameters
datasetanyoptional

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/community_resources/{community}/'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "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"
  }
}

Success

Update a given community resource

put
Path parameters
communityanyrequired

The community resource unique identifier

Query parameters
datasetanyoptional

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
all ofoptional

Responses
curl -L \
  --request PUT \
  --url 'http://www.data.gouv.fr/api/1/datasets/community_resources/{community}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "checksum": {
      "type": "sha1",
      "value": "text"
    },
    "created_at": "2025-03-25T05:00:16.425Z",
    "description": "text",
    "extras": {},
    "filesize": 1,
    "filetype": "file",
    "format": "text",
    "harvest": {
      "created_at": "2025-03-25T05:00:16.425Z",
      "modified_at": "2025-03-25T05:00:16.425Z",
      "uri": "text"
    },
    "id": "text",
    "internal": {
      "created_at_internal": "2025-03-25T05:00:16.425Z",
      "last_modified_internal": "2025-03-25T05:00:16.425Z"
    },
    "last_modified": "2025-03-25T05:00:16.425Z",
    "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"
    }
  }'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "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"
  }
}

Success

Delete a given community resource

delete
Path parameters
communityanyrequired

The community resource unique identifier

Query parameters
datasetanyoptional

The dataset ID or slug

Responses
curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/datasets/community_resources/{community}/'
No body

Success

Update the file related to a given community resource

post
Path parameters
communityanyrequired

The community resource unique identifier

Query parameters
datasetanyoptional

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/community_resources/{community}/upload/'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "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"
  },
  "success": true
}

Success

List all allowed resources extensions

get
Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/extensions/'
[
  "text"
]

Success

List all available frequencies

get
Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/frequencies/'
[
  {
    "id": "text",
    "label": "text"
  }
]

Success

List all available licenses

get
Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/licenses/'
[
  {
    "alternate_titles": [
      "text"
    ],
    "alternate_urls": [
      "text"
    ],
    "flags": [
      "text"
    ],
    "id": "text",
    "maintainer": "text",
    "title": "text",
    "url": "text"
  }
]

Success

Redirect to the latest version of a resource given its identifier

get
Path parameters
idanyrequired
Query parameters
datasetanyoptional

The dataset ID or slug

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/r/{id}'
No body

Success

List all resource types

get
Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/resource_types/'
[
  {
    "id": "text",
    "label": "text"
  }
]

Success

List all available schemas

get
Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/schemas/'
[
  {
    "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"
      }
    ]
  }
]

Success

Datasets suggest endpoint using mongoDB contains

get
Query parameters
qanyrequired

The string to autocomplete/suggest

sizeanyoptional

The amount of suggestion to fetch

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/suggest/'
{
  "acronym": "text",
  "id": "text",
  "image_url": "text",
  "page": "text",
  "slug": "text",
  "title": "text"
}

Success

Suggest file formats

get
Query parameters
qanyrequired

The string to autocomplete/suggest

sizeanyoptional

The amount of suggestion to fetch

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/suggest/formats/'
No body

Success

Suggest mime types

get
Query parameters
qanyrequired

The string to autocomplete/suggest

sizeanyoptional

The amount of suggestion to fetch

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/suggest/mime/'
No body

Success

Get a dataset given its identifier

get
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/'
{
  "acronym": "text",
  "archived": "2025-03-25T05:00:16.425Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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"
      }
    }
  ],
  "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-03-25T05:00:16.425Z",
  "deleted": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-03-25T05:00:16.425Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-03-25T05:00:16.425Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-03-25T05:00:16.425Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "last_update": "2025-03-25T05:00:16.425Z",
  "license": "text",
  "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",
  "private": true,
  "quality": {},
  "resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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": "text",
    "zones": [
      "text"
    ]
  },
  "tags": [
    "text"
  ],
  "temporal_coverage": {
    "end": "2025-03-25T05:00:16.425Z",
    "start": "2025-03-25T05:00:16.425Z"
  },
  "title": "text",
  "uri": "text"
}

Success

Update a dataset given its identifier

put
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
acronymstringoptional

An optional dataset acronym

archivedstring · date-timeoptional

The archival date if archived

badgesobject[]read-onlyoptional

The dataset badges

community_resourcesall of[]optional

The dataset community submitted resources

contact_pointsall of[]optional

The dataset contact points

created_atstring · date-timeread-onlyrequired

This date is computed between harvested creation date if any and site's internal creation date

deletedstring · date-timeread-onlyoptional

The deletion date if deleted

descriptionstring · markdownrequired

The dataset description in markdown

extrasobjectoptional

Extras attributes as key-value pairs

featuredbooleanoptional

Is the dataset featured

frequencystring · enum · default: "unknown"required

The update frequency

Example: unknown
Options: unknown, punctual, continuous, hourly, fourTimesADay, threeTimesADay, semidaily, daily, fourTimesAWeek, threeTimesAWeek, semiweekly, weekly, biweekly, threeTimesAMonth, semimonthly, monthly, bimonthly, quarterly, threeTimesAYear, semiannual, annual, biennial, triennial, quinquennial, irregular
frequency_datestring · date-timeoptional

Next expected update date, you will be notified once that date is reached.

harvestall ofread-onlyoptional

Dataset harvest metadata attributes

idstringread-onlyoptional

The dataset identifier

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyrequired

The dataset last modification date

last_updatestring · date-timerequired

The resources last modification date

licensestring · default: "notspecified"optional

The dataset license

metricsobjectoptional

The dataset metrics

organizationall ofoptional

The producer organization

ownerall ofoptional

The user information

pagestringrequired

The dataset page URL

privatebooleanoptional

Is the dataset private to the owner or the organization

qualityobjectread-onlyoptional

The dataset quality

resourcesall of[]optional

The dataset resources

schemaall ofoptional

Reference to the associated schema

slugstringrequired

The dataset permalink string

spatialall ofoptional

The spatial coverage

tagsstring[]optional
temporal_coverageall ofoptional

The temporal coverage

titlestringrequired

The dataset title

uristringrequired

The dataset API URI

Responses
curl -L \
  --request PUT \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "acronym": "text",
    "archived": "2025-03-25T05:00:16.425Z",
    "community_resources": [
      {
        "checksum": {
          "type": "sha1",
          "value": "text"
        },
        "created_at": "2025-03-25T05:00:16.425Z",
        "description": "text",
        "extras": {},
        "filesize": 1,
        "filetype": "file",
        "format": "text",
        "harvest": {
          "created_at": "2025-03-25T05:00:16.425Z",
          "modified_at": "2025-03-25T05:00:16.425Z",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-03-25T05:00:16.425Z",
          "last_modified_internal": "2025-03-25T05:00:16.425Z"
        },
        "last_modified": "2025-03-25T05:00:16.425Z",
        "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"
        }
      }
    ],
    "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"
      }
    ],
    "description": "text",
    "extras": {},
    "featured": true,
    "frequency": "unknown",
    "frequency_date": "2025-03-25T05:00:16.425Z",
    "harvest": {
      "archived": "text",
      "archived_at": "2025-03-25T05:00:16.425Z",
      "backend": "text",
      "ckan_name": "text",
      "ckan_source": "text",
      "created_at": "2025-03-25T05:00:16.425Z",
      "dct_identifier": "text",
      "domain": "text",
      "last_update": "2025-03-25T05:00:16.425Z",
      "modified_at": "2025-03-25T05:00:16.425Z",
      "remote_id": "text",
      "remote_url": "text",
      "source_id": "text",
      "uri": "text"
    },
    "internal": {
      "created_at_internal": "2025-03-25T05:00:16.425Z",
      "last_modified_internal": "2025-03-25T05:00:16.425Z"
    },
    "last_update": "2025-03-25T05:00:16.425Z",
    "license": "text",
    "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",
    "private": true,
    "quality": {},
    "resources": [
      {
        "checksum": {
          "type": "sha1",
          "value": "text"
        },
        "created_at": "2025-03-25T05:00:16.425Z",
        "description": "text",
        "extras": {},
        "filesize": 1,
        "filetype": "file",
        "format": "text",
        "harvest": {
          "created_at": "2025-03-25T05:00:16.425Z",
          "modified_at": "2025-03-25T05:00:16.425Z",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-03-25T05:00:16.425Z",
          "last_modified_internal": "2025-03-25T05:00:16.425Z"
        },
        "last_modified": "2025-03-25T05:00:16.425Z",
        "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": "text",
      "zones": [
        "text"
      ]
    },
    "tags": [
      "text"
    ],
    "temporal_coverage": {
      "end": "2025-03-25T05:00:16.425Z",
      "start": "2025-03-25T05:00:16.425Z"
    },
    "title": "text",
    "uri": "text"
  }'
{
  "acronym": "text",
  "archived": "2025-03-25T05:00:16.425Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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"
      }
    }
  ],
  "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-03-25T05:00:16.425Z",
  "deleted": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-03-25T05:00:16.425Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-03-25T05:00:16.425Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-03-25T05:00:16.425Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "last_update": "2025-03-25T05:00:16.425Z",
  "license": "text",
  "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",
  "private": true,
  "quality": {},
  "resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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": "text",
    "zones": [
      "text"
    ]
  },
  "tags": [
    "text"
  ],
  "temporal_coverage": {
    "end": "2025-03-25T05:00:16.425Z",
    "start": "2025-03-25T05:00:16.425Z"
  },
  "title": "text",
  "uri": "text"
}

Success

Delete a dataset given its identifier

delete
Path parameters
datasetanyrequired

The dataset ID or slug

Responses
curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/'
No body

Dataset deleted

Create a new badge for a given dataset

post
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
kindstringrequired

Kind of badge (certified, etc), specific to each model

Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/badges/' \
  --header 'Content-Type: application/json' \
  --data '{
    "kind": "text"
  }'
{
  "kind": "text"
}

Success

Delete a badge for a given dataset

delete
Path parameters
badge_kindanyrequired
datasetanyrequired

The dataset ID or slug

Responses
curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/badges/{badge_kind}/'
No body

Success

Mark the dataset as featured

post
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/featured/'
{
  "acronym": "text",
  "archived": "2025-03-25T05:00:16.425Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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"
      }
    }
  ],
  "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-03-25T05:00:16.425Z",
  "deleted": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-03-25T05:00:16.425Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-03-25T05:00:16.425Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-03-25T05:00:16.425Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "last_update": "2025-03-25T05:00:16.425Z",
  "license": "text",
  "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",
  "private": true,
  "quality": {},
  "resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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": "text",
    "zones": [
      "text"
    ]
  },
  "tags": [
    "text"
  ],
  "temporal_coverage": {
    "end": "2025-03-25T05:00:16.425Z",
    "start": "2025-03-25T05:00:16.425Z"
  },
  "title": "text",
  "uri": "text"
}

Success

Unmark the dataset as featured

delete
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/featured/'
{
  "acronym": "text",
  "archived": "2025-03-25T05:00:16.425Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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"
      }
    }
  ],
  "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-03-25T05:00:16.425Z",
  "deleted": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-03-25T05:00:16.425Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-03-25T05:00:16.425Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-03-25T05:00:16.425Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "last_update": "2025-03-25T05:00:16.425Z",
  "license": "text",
  "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",
  "private": true,
  "quality": {},
  "resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-03-25T05:00:16.425Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "last_modified": "2025-03-25T05:00:16.425Z",
      "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": "text",
    "zones": [
      "text"
    ]
  },
  "tags": [
    "text"
  ],
  "temporal_coverage": {
    "end": "2025-03-25T05:00:16.425Z",
    "start": "2025-03-25T05:00:16.425Z"
  },
  "title": "text",
  "uri": "text"
}

Success

get
Path parameters
datasetanyrequired

The dataset ID or slug

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/rdf'
No body

Dataset not found

get
Path parameters
datasetanyrequired

The dataset ID or slug

formatanyrequired
Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/rdf.{format}'
No body

Dataset not found

Create a new resource for a given dataset

post
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
checksumall ofoptional

A checksum to validate file validity

created_atstring · date-timeread-onlyoptional

The resource creation date

descriptionstring · markdownoptional

The resource markdown description

extrasobjectoptional

Extra attributes as key-value pairs

filesizeintegeroptional

The resource file size in bytes

filetypestring · enumrequired

Whether the resource is an uploaded file, a remote file or an API

Example: file
Options: file, remote
formatstringrequired

The resource format

harvestall ofread-onlyoptional

Harvest attributes metadata information

idstringread-onlyoptional

The resource unique ID

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyoptional

The resource last modification date

lateststringread-onlyoptional

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.

metricsobjectread-onlyoptional

The resource metrics

mimestringoptional

The resource mime type

preview_urlstringread-onlyoptional

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall ofoptional

Reference to the associated schema

titlestringrequired

The resource title

typestring · enumrequired

Resource type (documentation, API...)

Example: main
Options: main, documentation, update, api, code, other
urlstringrequired

The resource URL

Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/resources/' \
  --header 'Content-Type: application/json' \
  --data '{
    "checksum": {
      "type": "sha1",
      "value": "text"
    },
    "description": "text",
    "extras": {},
    "filesize": 1,
    "filetype": "file",
    "format": "text",
    "harvest": {
      "created_at": "2025-03-25T05:00:16.425Z",
      "modified_at": "2025-03-25T05:00:16.425Z",
      "uri": "text"
    },
    "internal": {
      "created_at_internal": "2025-03-25T05:00:16.425Z",
      "last_modified_internal": "2025-03-25T05:00:16.425Z"
    },
    "metrics": {},
    "mime": "text",
    "schema": {
      "name": "text",
      "url": "text",
      "version": "text"
    },
    "title": "text",
    "type": "main",
    "url": "text"
  }'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text"
}

Success

Reorder resources

put
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
checksumall ofoptional

A checksum to validate file validity

created_atstring · date-timeread-onlyoptional

The resource creation date

descriptionstring · markdownoptional

The resource markdown description

extrasobjectoptional

Extra attributes as key-value pairs

filesizeintegeroptional

The resource file size in bytes

filetypestring · enumrequired

Whether the resource is an uploaded file, a remote file or an API

Example: file
Options: file, remote
formatstringrequired

The resource format

harvestall ofread-onlyoptional

Harvest attributes metadata information

idstringread-onlyoptional

The resource unique ID

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyoptional

The resource last modification date

lateststringread-onlyoptional

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.

metricsobjectread-onlyoptional

The resource metrics

mimestringoptional

The resource mime type

preview_urlstringread-onlyoptional

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall ofoptional

Reference to the associated schema

titlestringrequired

The resource title

typestring · enumrequired

Resource type (documentation, API...)

Example: main
Options: main, documentation, update, api, code, other
urlstringrequired

The resource URL

Responses
curl -L \
  --request PUT \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/resources/' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-03-25T05:00:16.425Z",
        "modified_at": "2025-03-25T05:00:16.425Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-03-25T05:00:16.425Z",
        "last_modified_internal": "2025-03-25T05:00:16.425Z"
      },
      "metrics": {},
      "mime": "text",
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "title": "text",
      "type": "main",
      "url": "text"
    }
  ]'
[
  {
    "checksum": {
      "type": "sha1",
      "value": "text"
    },
    "created_at": "2025-03-25T05:00:16.425Z",
    "description": "text",
    "extras": {},
    "filesize": 1,
    "filetype": "file",
    "format": "text",
    "harvest": {
      "created_at": "2025-03-25T05:00:16.425Z",
      "modified_at": "2025-03-25T05:00:16.425Z",
      "uri": "text"
    },
    "id": "text",
    "internal": {
      "created_at_internal": "2025-03-25T05:00:16.425Z",
      "last_modified_internal": "2025-03-25T05:00:16.425Z"
    },
    "last_modified": "2025-03-25T05:00:16.425Z",
    "latest": "text",
    "metrics": {},
    "mime": "text",
    "preview_url": "text",
    "schema": {
      "name": "text",
      "url": "text",
      "version": "text"
    },
    "title": "text",
    "type": "main",
    "url": "text"
  }
]

Success

Get a resource given its identifier

get
Path parameters
ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/resources/{rid}/'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text"
}

Success

Update a given resource on a given dataset

put
Path parameters
ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
checksumall ofoptional

A checksum to validate file validity

created_atstring · date-timeread-onlyoptional

The resource creation date

descriptionstring · markdownoptional

The resource markdown description

extrasobjectoptional

Extra attributes as key-value pairs

filesizeintegeroptional

The resource file size in bytes

filetypestring · enumrequired

Whether the resource is an uploaded file, a remote file or an API

Example: file
Options: file, remote
formatstringrequired

The resource format

harvestall ofread-onlyoptional

Harvest attributes metadata information

idstringread-onlyoptional

The resource unique ID

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyoptional

The resource last modification date

lateststringread-onlyoptional

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.

metricsobjectread-onlyoptional

The resource metrics

mimestringoptional

The resource mime type

preview_urlstringread-onlyoptional

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall ofoptional

Reference to the associated schema

titlestringrequired

The resource title

typestring · enumrequired

Resource type (documentation, API...)

Example: main
Options: main, documentation, update, api, code, other
urlstringrequired

The resource URL

Responses
curl -L \
  --request PUT \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/resources/{rid}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "checksum": {
      "type": "sha1",
      "value": "text"
    },
    "description": "text",
    "extras": {},
    "filesize": 1,
    "filetype": "file",
    "format": "text",
    "harvest": {
      "created_at": "2025-03-25T05:00:16.425Z",
      "modified_at": "2025-03-25T05:00:16.425Z",
      "uri": "text"
    },
    "internal": {
      "created_at_internal": "2025-03-25T05:00:16.425Z",
      "last_modified_internal": "2025-03-25T05:00:16.425Z"
    },
    "metrics": {},
    "mime": "text",
    "schema": {
      "name": "text",
      "url": "text",
      "version": "text"
    },
    "title": "text",
    "type": "main",
    "url": "text"
  }'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text"
}

Success

Delete a given resource on a given dataset

delete
Path parameters
ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Responses
curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/resources/{rid}/'
No body

Success

Checks that a resource's URL exists and returns metadata

get
Path parameters
ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/resources/{rid}/check/'
No body

Success

Upload a file related to a given resource on a given dataset

post
Path parameters
ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/resources/{rid}/upload/'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text",
  "success": true
}

Success

Upload a file for a new dataset resource

post
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
filefileoptional
uuidstringoptional
filenamestringoptional
partindexintegeroptional
partbyteoffsetintegeroptional
totalpartsintegeroptional
chunksizeintegeroptional
Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/upload/' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'file=null&uuid=text&filename=text&partindex=1&partbyteoffset=1&totalparts=1&chunksize=1'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text",
  "success": true
}

Success

Upload a new community resource

post
Path parameters
datasetanyrequired

The dataset ID or slug

Header parameters
X-Fieldsanyoptional

An optional fields mask

Body
filefileoptional
uuidstringoptional
filenamestringoptional
partindexintegeroptional
partbyteoffsetintegeroptional
totalpartsintegeroptional
chunksizeintegeroptional
Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/{dataset}/upload/community/' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'file=null&uuid=text&filename=text&partindex=1&partbyteoffset=1&totalparts=1&chunksize=1'
{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-03-25T05:00:16.425Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-03-25T05:00:16.425Z",
    "modified_at": "2025-03-25T05:00:16.425Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-03-25T05:00:16.425Z",
    "last_modified_internal": "2025-03-25T05:00:16.425Z"
  },
  "last_modified": "2025-03-25T05:00:16.425Z",
  "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"
  },
  "success": true
}

Success

List all followers for a given object

get
Path parameters
idanyrequired
Query parameters
pageanyoptional

The page to fetch

page_sizeanyoptional

The page size to fetch

Header parameters
X-Fieldsanyoptional

An optional fields mask

Responses
curl -L \
  --url 'http://www.data.gouv.fr/api/1/datasets/{id}/followers/'
{
  "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-03-25T05:00:16.425Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Success

Follow an object given its ID

post

Returns the number of followers left after the operation

Path parameters
idanyrequired
Responses
curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/datasets/{id}/followers/'
No body

Success

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Path parameters
idanyrequired
Responses
curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/datasets/{id}/followers/'
No body

Success

PrécédentsiteSuivantreuses

Dernière mise à jour

Cet article vous a-t-il été utile ?