datasets

Dataset related operations

List or search all datasets

get

/datasets/

Query parameters

qstring

The search query

sortstring · enum

The field (and direction) on which sorting apply

Options: title, created, last_update, reuses, followers, views, -title, -created, -last_update, -reuses, -followers, -views

pageinteger · default: 1

The page to display

page_sizeinteger · default: 20

The page size

tagstring[]

licensestring

featuredboolean

geozonestring

granularitystring

temporal_coveragestring

organizationstring

organization_badgestring · enum

Options: public-service, certified, association, company, local-authority

ownerstring

formatstring

schemastring

schema_versionstring

topicstring

creditstring

dataservicestring

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/'

200

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "acronym": "text",
      "archived": "2025-02-20T19:10:52.435Z",
      "created_at": "2025-02-20T19:10:52.435Z",
      "deleted": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "featured": true,
      "frequency_date": "2025-02-20T19:10:52.435Z",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "last_update": "2025-02-20T19:10:52.435Z",
      "license": "notspecified",
      "metrics": {},
      "page": "text",
      "private": true,
      "quality": {},
      "slug": "text",
      "title": "text",
      "uri": "text",
      "frequency": "unknown",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "harvest": {
        "archived": "text",
        "archived_at": "2025-02-20T19:10:52.435Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2025-02-20T19:10:52.435Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "text"
          }
        ]
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "spatial": {
        "granularity": "other",
        "zones": [
          "text"
        ],
        "geom": {
          "type": "Point",
          "coordinates": [
            {}
          ]
        }
      },
      "temporal_coverage": {
        "end": "2025-02-20T19:10:52.435Z",
        "start": "2025-02-20T19:10:52.435Z"
      },
      "community_resources": [
        {
          "created_at": "2025-02-20T19:10:52.435Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "format": "text",
          "id": "text",
          "last_modified": "2025-02-20T19:10:52.435Z",
          "latest": "text",
          "metrics": {},
          "mime": "text",
          "preview_url": "text",
          "title": "text",
          "url": "text",
          "filetype": "file",
          "type": "main",
          "checksum": {
            "value": "text",
            "type": "sha1"
          },
          "harvest": {
            "created_at": "2025-02-20T19:10:52.435Z",
            "modified_at": "2025-02-20T19:10:52.435Z",
            "uri": "text"
          },
          "internal": {
            "created_at_internal": "2025-02-20T19:10:52.435Z",
            "last_modified_internal": "2025-02-20T19:10:52.435Z"
          },
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          },
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          },
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "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",
          "role": "text",
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text",
            "badges": [
              {
                "kind": "text"
              }
            ]
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          }
        }
      ],
      "resources": [
        {
          "created_at": "2025-02-20T19:10:52.435Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "format": "text",
          "id": "text",
          "last_modified": "2025-02-20T19:10:52.435Z",
          "latest": "text",
          "metrics": {},
          "mime": "text",
          "preview_url": "text",
          "title": "text",
          "url": "text",
          "filetype": "file",
          "type": "main",
          "checksum": {
            "value": "text",
            "type": "sha1"
          },
          "harvest": {
            "created_at": "2025-02-20T19:10:52.435Z",
            "modified_at": "2025-02-20T19:10:52.435Z",
            "uri": "text"
          },
          "internal": {
            "created_at_internal": "2025-02-20T19:10:52.435Z",
            "last_modified_internal": "2025-02-20T19:10:52.435Z"
          },
          "schema": {
            "name": "text",
            "url": "text",
            "version": "text"
          }
        }
      ]
    }
  ]
}

Success

Create a new dataset

post

/datasets/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

acronymstring

An optional dataset acronym

archivedstring · date-time

The archival date if archived

created_atstring · date-timerequired

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

deletedstring · date-time

The deletion date if deleted

descriptionstring · markdownrequired

The dataset description in markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the dataset featured

frequency_datestring · date-time

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

idstring

The dataset identifier

last_modifiedstring · date-timerequired

The dataset last modification date

last_updatestring · date-timerequired

The resources last modification date

licensestring · default: notspecified

The dataset license

metricsobject

The dataset metrics

pagestringrequired

The dataset page URL

privateboolean

Is the dataset private to the owner or the organization

qualityobject

The dataset quality

slugstringrequired

The dataset permalink string

titlestringrequired

The dataset title

uristringrequired

The dataset API URI

frequencystring · enum · default: unknownrequired

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

badgesobject[]

The dataset badges

tagsstring[]

harvestall of

Dataset harvest metadata attributes

internalall of

Site internal and specific object's data

organizationall of

The producer organization

ownerall of

The user information

schemaall of

Reference to the associated schema

spatialall of

The spatial coverage

temporal_coverageall of

The temporal coverage

community_resourcesall of[]

contact_pointsall of[]

resourcesall of[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/' \
  --header 'Content-Type: application/json' \
  --data '{"created_at":"2025-02-20T19:10:52.435Z","description":"text","extras":{},"last_modified":"2025-02-20T19:10:52.435Z","last_update":"2025-02-20T19:10:52.435Z","license":"notspecified","metrics":{},"page":"text","quality":{},"slug":"text","title":"text","uri":"text","frequency":"unknown","badges":[{"kind":"text"}],"tags":[null],"harvest":{"archived":"text","archived_at":"2025-02-20T19:10:52.435Z","backend":"text","ckan_name":"text","ckan_source":"text","created_at":"2025-02-20T19:10:52.435Z","dct_identifier":"text","domain":"text","last_update":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","remote_id":"text","remote_url":"text","source_id":"text","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"},"schema":{"name":"text","url":"text","version":"text"},"spatial":{"granularity":"other","zones":["text"],"geom":{"type":"Point","coordinates":[{}]}},"temporal_coverage":{"end":"2025-02-20T19:10:52.435Z","start":"2025-02-20T19:10:52.435Z"},"community_resources":[{"created_at":"2025-02-20T19:10:52.435Z","description":"text","extras":{},"filesize":1,"format":"text","id":"text","last_modified":"2025-02-20T19:10:52.435Z","latest":"text","metrics":{},"mime":"text","preview_url":"text","title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"},"dataset":{"class":"text","id":"text","acronym":"text","page":"text","title":"text","uri":"text"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"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","role":"text","organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}],"resources":[{"created_at":"2025-02-20T19:10:52.435Z","description":"text","extras":{},"filesize":1,"format":"text","id":"text","last_modified":"2025-02-20T19:10:52.435Z","latest":"text","metrics":{},"mime":"text","preview_url":"text","title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"}}]}'

201

400

201

{
  "acronym": "text",
  "archived": "2025-02-20T19:10:52.435Z",
  "created_at": "2025-02-20T19:10:52.435Z",
  "deleted": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency_date": "2025-02-20T19:10:52.435Z",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "last_update": "2025-02-20T19:10:52.435Z",
  "license": "notspecified",
  "metrics": {},
  "page": "text",
  "private": true,
  "quality": {},
  "slug": "text",
  "title": "text",
  "uri": "text",
  "frequency": "unknown",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "harvest": {
    "archived": "text",
    "archived_at": "2025-02-20T19:10:52.435Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-02-20T19:10:52.435Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "spatial": {
    "granularity": "other",
    "zones": [
      "text"
    ],
    "geom": {
      "type": "Point",
      "coordinates": [
        {}
      ]
    }
  },
  "temporal_coverage": {
    "end": "2025-02-20T19:10:52.435Z",
    "start": "2025-02-20T19:10:52.435Z"
  },
  "community_resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "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",
      "role": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "text"
          }
        ]
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      }
    }
  ]
}

Success

List all available dataset badges and their labels

get

/datasets/badges/

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/badges/'

200

200

No body

Success

List all community resources

get

/datasets/community_resources/

Query parameters

sortstring · default: -created_at_internal

The sorting attribute

pageinteger · default: 1

The page to fetch

page_sizeinteger · default: 20

The page size to fetch

organizationstring

Filter activities for that particular organization

datasetstring

Filter activities for that particular dataset

ownerstring

Filter activities for that particular user

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/community_resources/'

200

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "text"
          }
        ]
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ]
}

Success

Create a new community resource

post

/datasets/community_resources/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

created_atstring · date-time

The resource creation date

descriptionstring · markdown

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

formatstringrequired

The resource format

idstring

The resource unique ID

last_modifiedstring · date-time

The resource last modification date

lateststring

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.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

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

titlestringrequired

The resource title

urlstringrequired

The resource URL

filetypestring · enumrequired

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

Example: file

Options: file, remote

typestring · enumrequired

Resource type (documentation, API...)

Example: main

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

checksumall of

A checksum to validate file validity

harvestall of

Harvest attributes metadata information

internalall of

Site internal and specific object's data

schemaall of

Reference to the associated schema

datasetall of

Reference to the associated dataset

organizationall of

The producer organization

ownerall of

The user information

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/community_resources/' \
  --header 'Content-Type: application/json' \
  --data '{"created_at":"2025-02-20T19:10:52.435Z","description":"text","extras":{},"filesize":1,"format":"text","id":"text","last_modified":"2025-02-20T19:10:52.435Z","latest":"text","metrics":{},"mime":"text","preview_url":"text","title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"},"dataset":{"class":"text","id":"text","acronym":"text","page":"text","title":"text","uri":"text"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}'

201

400

201

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "dataset": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "page": "text",
    "title": "text",
    "uri": "text"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "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

/datasets/community_resources/{community}//

Path parameters

communitystringrequired

The community resource unique identifier

Query parameters

datasetstring

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/community_resources/{community}/'

200

200

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "dataset": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "page": "text",
    "title": "text",
    "uri": "text"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "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

/datasets/community_resources/{community}//

Path parameters

communitystringrequired

The community resource unique identifier

Query parameters

datasetstring

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

created_atstring · date-time

The resource creation date

descriptionstring · markdown

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

formatstringrequired

The resource format

idstring

The resource unique ID

last_modifiedstring · date-time

The resource last modification date

lateststring

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.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

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

titlestringrequired

The resource title

urlstringrequired

The resource URL

filetypestring · enumrequired

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

Example: file

Options: file, remote

typestring · enumrequired

Resource type (documentation, API...)

Example: main

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

checksumall of

A checksum to validate file validity

harvestall of

Harvest attributes metadata information

internalall of

Site internal and specific object's data

schemaall of

Reference to the associated schema

datasetall of

Reference to the associated dataset

organizationall of

The producer organization

ownerall of

The user information

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/datasets/community_resources/{community}/' \
  --header 'Content-Type: application/json' \
  --data '{"created_at":"2025-02-20T19:10:52.435Z","description":"text","extras":{},"filesize":1,"format":"text","id":"text","last_modified":"2025-02-20T19:10:52.435Z","latest":"text","metrics":{},"mime":"text","preview_url":"text","title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"},"dataset":{"class":"text","id":"text","acronym":"text","page":"text","title":"text","uri":"text"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}'

200

400

200

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "dataset": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "page": "text",
    "title": "text",
    "uri": "text"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "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

/datasets/community_resources/{community}//

Path parameters

communitystringrequired

The community resource unique identifier

Query parameters

datasetstring

The dataset ID or slug

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

Success

Update the file related to a given community resource

post

/datasets/community_resources/{community}/upload/

Path parameters

communitystringrequired

The community resource unique identifier

Query parameters

datasetstring

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/community_resources/{community}/upload/'

200

400

415

200

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "dataset": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "page": "text",
    "title": "text",
    "uri": "text"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "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

/datasets/extensions/

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/extensions/'

200

200

[
  "text"
]

Success

List all available frequencies

get

/datasets/frequencies/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/frequencies/'

200

200

[
  {
    "id": "text",
    "label": "text"
  }
]

Success

List all available licenses

get

/datasets/licenses/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/licenses/'

200

200

[
  {
    "id": "text",
    "maintainer": "text",
    "title": "text",
    "url": "text",
    "alternate_titles": [
      "text"
    ],
    "alternate_urls": [
      "text"
    ],
    "flags": [
      "text"
    ]
  }
]

Success

Redirect to the latest version of a resource given its identifier

get

/datasets/r/{id}

Path parameters

idstringrequired

Query parameters

datasetstring

The dataset ID or slug

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/r/{id}'

200

200

No body

Success

List all resource types

get

/datasets/resource_types/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/resource_types/'

200

200

[
  {
    "id": "text",
    "label": "text"
  }
]

Success

List all available schemas

get

/datasets/schemas/

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/schemas/'

200

200

[
  {
    "consolidation_dataset_id": "text",
    "contact": "text",
    "datapackage_description": "text",
    "datapackage_name": "text",
    "datapackage_title": "text",
    "description": "text",
    "external_doc": "text",
    "external_tool": "text",
    "homepage": "text",
    "name": "text",
    "schema_url": "text",
    "title": "text",
    "schema_type": "tableschema",
    "examples": [
      {
        "path": "text",
        "title": "text"
      }
    ],
    "labels": [
      "text"
    ],
    "versions": [
      {
        "schema_url": "text",
        "version_name": "text"
      }
    ]
  }
]

Success

Datasets suggest endpoint using mongoDB contains

get

/datasets/suggest/

Query parameters

qstringrequired

The string to autocomplete/suggest

sizeinteger · default: 10

The amount of suggestion to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/suggest/?q=text'

200

200

{
  "acronym": "text",
  "id": "text",
  "image_url": "text",
  "page": "text",
  "slug": "text",
  "title": "text"
}

Success

Suggest file formats

get

/datasets/suggest/formats/

Query parameters

qstringrequired

The string to autocomplete/suggest

sizeinteger · default: 10

The amount of suggestion to fetch

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/suggest/formats/?q=text'

200

200

No body

Success

Suggest mime types

get

/datasets/suggest/mime/

Query parameters

qstringrequired

The string to autocomplete/suggest

sizeinteger · default: 10

The amount of suggestion to fetch

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/suggest/mime/?q=text'

200

200

No body

Success

Get a dataset given its identifier

get

/datasets/{dataset}//

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/'

200

404

410

200

{
  "acronym": "text",
  "archived": "2025-02-20T19:10:52.435Z",
  "created_at": "2025-02-20T19:10:52.435Z",
  "deleted": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency_date": "2025-02-20T19:10:52.435Z",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "last_update": "2025-02-20T19:10:52.435Z",
  "license": "notspecified",
  "metrics": {},
  "page": "text",
  "private": true,
  "quality": {},
  "slug": "text",
  "title": "text",
  "uri": "text",
  "frequency": "unknown",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "harvest": {
    "archived": "text",
    "archived_at": "2025-02-20T19:10:52.435Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-02-20T19:10:52.435Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "spatial": {
    "granularity": "other",
    "zones": [
      "text"
    ],
    "geom": {
      "type": "Point",
      "coordinates": [
        {}
      ]
    }
  },
  "temporal_coverage": {
    "end": "2025-02-20T19:10:52.435Z",
    "start": "2025-02-20T19:10:52.435Z"
  },
  "community_resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "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",
      "role": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "text"
          }
        ]
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      }
    }
  ]
}

Success

Update a dataset given its identifier

put

/datasets/{dataset}//

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

acronymstring

An optional dataset acronym

archivedstring · date-time

The archival date if archived

created_atstring · date-timerequired

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

deletedstring · date-time

The deletion date if deleted

descriptionstring · markdownrequired

The dataset description in markdown

extrasobject

Extras attributes as key-value pairs

featuredboolean

Is the dataset featured

frequency_datestring · date-time

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

idstring

The dataset identifier

last_modifiedstring · date-timerequired

The dataset last modification date

last_updatestring · date-timerequired

The resources last modification date

licensestring · default: notspecified

The dataset license

metricsobject

The dataset metrics

pagestringrequired

The dataset page URL

privateboolean

Is the dataset private to the owner or the organization

qualityobject

The dataset quality

slugstringrequired

The dataset permalink string

titlestringrequired

The dataset title

uristringrequired

The dataset API URI

frequencystring · enum · default: unknownrequired

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

badgesobject[]

The dataset badges

tagsstring[]

harvestall of

Dataset harvest metadata attributes

internalall of

Site internal and specific object's data

organizationall of

The producer organization

ownerall of

The user information

schemaall of

Reference to the associated schema

spatialall of

The spatial coverage

temporal_coverageall of

The temporal coverage

community_resourcesall of[]

contact_pointsall of[]

resourcesall of[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/' \
  --header 'Content-Type: application/json' \
  --data '{"created_at":"2025-02-20T19:10:52.435Z","description":"text","extras":{},"last_modified":"2025-02-20T19:10:52.435Z","last_update":"2025-02-20T19:10:52.435Z","license":"notspecified","metrics":{},"page":"text","quality":{},"slug":"text","title":"text","uri":"text","frequency":"unknown","badges":[{"kind":"text"}],"tags":[null],"harvest":{"archived":"text","archived_at":"2025-02-20T19:10:52.435Z","backend":"text","ckan_name":"text","ckan_source":"text","created_at":"2025-02-20T19:10:52.435Z","dct_identifier":"text","domain":"text","last_update":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","remote_id":"text","remote_url":"text","source_id":"text","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"},"schema":{"name":"text","url":"text","version":"text"},"spatial":{"granularity":"other","zones":["text"],"geom":{"type":"Point","coordinates":[{}]}},"temporal_coverage":{"end":"2025-02-20T19:10:52.435Z","start":"2025-02-20T19:10:52.435Z"},"community_resources":[{"created_at":"2025-02-20T19:10:52.435Z","description":"text","extras":{},"filesize":1,"format":"text","id":"text","last_modified":"2025-02-20T19:10:52.435Z","latest":"text","metrics":{},"mime":"text","preview_url":"text","title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"},"dataset":{"class":"text","id":"text","acronym":"text","page":"text","title":"text","uri":"text"},"organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"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","role":"text","organization":{"class":"text","id":"text","acronym":"text","logo":"text","logo_thumbnail":"text","name":"text","page":"text","slug":"text","uri":"text","badges":[{"kind":"text"}]},"owner":{"class":"text","id":"text","avatar":"text","avatar_thumbnail":"text","first_name":"text","last_name":"text","page":"text","slug":"text","uri":"text"}}],"resources":[{"created_at":"2025-02-20T19:10:52.435Z","description":"text","extras":{},"filesize":1,"format":"text","id":"text","last_modified":"2025-02-20T19:10:52.435Z","latest":"text","metrics":{},"mime":"text","preview_url":"text","title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"}}]}'

200

400

404

410

200

{
  "acronym": "text",
  "archived": "2025-02-20T19:10:52.435Z",
  "created_at": "2025-02-20T19:10:52.435Z",
  "deleted": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency_date": "2025-02-20T19:10:52.435Z",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "last_update": "2025-02-20T19:10:52.435Z",
  "license": "notspecified",
  "metrics": {},
  "page": "text",
  "private": true,
  "quality": {},
  "slug": "text",
  "title": "text",
  "uri": "text",
  "frequency": "unknown",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "harvest": {
    "archived": "text",
    "archived_at": "2025-02-20T19:10:52.435Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-02-20T19:10:52.435Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "spatial": {
    "granularity": "other",
    "zones": [
      "text"
    ],
    "geom": {
      "type": "Point",
      "coordinates": [
        {}
      ]
    }
  },
  "temporal_coverage": {
    "end": "2025-02-20T19:10:52.435Z",
    "start": "2025-02-20T19:10:52.435Z"
  },
  "community_resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "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",
      "role": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "text"
          }
        ]
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      }
    }
  ]
}

Success

Delete a dataset given its identifier

delete

/datasets/{dataset}//

Path parameters

datasetstringrequired

The dataset ID or slug

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

404

410

204

No body

Dataset deleted

Create a new badge for a given dataset

post

/datasets/{dataset}/badges/

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

kindstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "kind": "text"
}

Success

Delete a badge for a given dataset

delete

/datasets/{dataset}/badges/{badge_kind}//

Path parameters

badge_kindstringrequired

datasetstringrequired

The dataset ID or slug

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

Success

Mark the dataset as featured

post

/datasets/{dataset}/featured/

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/featured/'

200

200

{
  "acronym": "text",
  "archived": "2025-02-20T19:10:52.435Z",
  "created_at": "2025-02-20T19:10:52.435Z",
  "deleted": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency_date": "2025-02-20T19:10:52.435Z",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "last_update": "2025-02-20T19:10:52.435Z",
  "license": "notspecified",
  "metrics": {},
  "page": "text",
  "private": true,
  "quality": {},
  "slug": "text",
  "title": "text",
  "uri": "text",
  "frequency": "unknown",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "harvest": {
    "archived": "text",
    "archived_at": "2025-02-20T19:10:52.435Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-02-20T19:10:52.435Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "spatial": {
    "granularity": "other",
    "zones": [
      "text"
    ],
    "geom": {
      "type": "Point",
      "coordinates": [
        {}
      ]
    }
  },
  "temporal_coverage": {
    "end": "2025-02-20T19:10:52.435Z",
    "start": "2025-02-20T19:10:52.435Z"
  },
  "community_resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "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",
      "role": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "text"
          }
        ]
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      }
    }
  ]
}

Success

Unmark the dataset as featured

delete

/datasets/{dataset}/featured/

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/featured/'

200

200

{
  "acronym": "text",
  "archived": "2025-02-20T19:10:52.435Z",
  "created_at": "2025-02-20T19:10:52.435Z",
  "deleted": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency_date": "2025-02-20T19:10:52.435Z",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "last_update": "2025-02-20T19:10:52.435Z",
  "license": "notspecified",
  "metrics": {},
  "page": "text",
  "private": true,
  "quality": {},
  "slug": "text",
  "title": "text",
  "uri": "text",
  "frequency": "unknown",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "tags": [
    "text"
  ],
  "harvest": {
    "archived": "text",
    "archived_at": "2025-02-20T19:10:52.435Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-02-20T19:10:52.435Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "text"
      }
    ]
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "spatial": {
    "granularity": "other",
    "zones": [
      "text"
    ],
    "geom": {
      "type": "Point",
      "coordinates": [
        {}
      ]
    }
  },
  "temporal_coverage": {
    "end": "2025-02-20T19:10:52.435Z",
    "start": "2025-02-20T19:10:52.435Z"
  },
  "community_resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "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",
      "role": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text",
        "badges": [
          {
            "kind": "text"
          }
        ]
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "resources": [
    {
      "created_at": "2025-02-20T19:10:52.435Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "format": "text",
      "id": "text",
      "last_modified": "2025-02-20T19:10:52.435Z",
      "latest": "text",
      "metrics": {},
      "mime": "text",
      "preview_url": "text",
      "title": "text",
      "url": "text",
      "filetype": "file",
      "type": "main",
      "checksum": {
        "value": "text",
        "type": "sha1"
      },
      "harvest": {
        "created_at": "2025-02-20T19:10:52.435Z",
        "modified_at": "2025-02-20T19:10:52.435Z",
        "uri": "text"
      },
      "internal": {
        "created_at_internal": "2025-02-20T19:10:52.435Z",
        "last_modified_internal": "2025-02-20T19:10:52.435Z"
      },
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      }
    }
  ]
}

Success

get

/datasets/{dataset}/rdf

Path parameters

datasetstringrequired

The dataset ID or slug

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/rdf'

404

410

404

No body

Dataset not found

get

/datasets/{dataset}/rdf.{format}

Path parameters

datasetstringrequired

The dataset ID or slug

formatstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/rdf.{format}'

404

410

404

No body

Dataset not found

Create a new resource for a given dataset

post

/datasets/{dataset}/resources/

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

created_atstring · date-time

The resource creation date

descriptionstring · markdown

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

formatstringrequired

The resource format

idstring

The resource unique ID

last_modifiedstring · date-time

The resource last modification date

lateststring

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.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

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

titlestringrequired

The resource title

urlstringrequired

The resource URL

filetypestring · enumrequired

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

Example: file

Options: file, remote

typestring · enumrequired

Resource type (documentation, API...)

Example: main

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

checksumall of

A checksum to validate file validity

harvestall of

Harvest attributes metadata information

internalall of

Site internal and specific object's data

schemaall of

Reference to the associated schema

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/resources/' \
  --header 'Content-Type: application/json' \
  --data '{"extras":{},"format":"text","metrics":{},"title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"}}'

201

400

201

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  }
}

Success

Reorder resources

put

/datasets/{dataset}/resources/

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

created_atstring · date-time

The resource creation date

descriptionstring · markdown

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

formatstringrequired

The resource format

idstring

The resource unique ID

last_modifiedstring · date-time

The resource last modification date

lateststring

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.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

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

titlestringrequired

The resource title

urlstringrequired

The resource URL

filetypestring · enumrequired

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

Example: file

Options: file, remote

typestring · enumrequired

Resource type (documentation, API...)

Example: main

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

checksumall of

A checksum to validate file validity

harvestall of

Harvest attributes metadata information

internalall of

Site internal and specific object's data

schemaall of

Reference to the associated schema

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/resources/' \
  --header 'Content-Type: application/json' \
  --data '[{"extras":{},"format":"text","metrics":{},"title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"}}]'

200

400

200

[
  {
    "created_at": "2025-02-20T19:10:52.435Z",
    "description": "text",
    "extras": {},
    "filesize": 1,
    "format": "text",
    "id": "text",
    "last_modified": "2025-02-20T19:10:52.435Z",
    "latest": "text",
    "metrics": {},
    "mime": "text",
    "preview_url": "text",
    "title": "text",
    "url": "text",
    "filetype": "file",
    "type": "main",
    "checksum": {
      "value": "text",
      "type": "sha1"
    },
    "harvest": {
      "created_at": "2025-02-20T19:10:52.435Z",
      "modified_at": "2025-02-20T19:10:52.435Z",
      "uri": "text"
    },
    "internal": {
      "created_at_internal": "2025-02-20T19:10:52.435Z",
      "last_modified_internal": "2025-02-20T19:10:52.435Z"
    },
    "schema": {
      "name": "text",
      "url": "text",
      "version": "text"
    }
  }
]

Success

Get a resource given its identifier

get

/datasets/{dataset}/resources/{rid}//

Path parameters

ridstringrequired

The resource unique identifier

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/resources/{rid}/'

200

200

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  }
}

Success

Update a given resource on a given dataset

put

/datasets/{dataset}/resources/{rid}//

Path parameters

ridstringrequired

The resource unique identifier

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

created_atstring · date-time

The resource creation date

descriptionstring · markdown

The resource markdown description

extrasobject

Extra attributes as key-value pairs

filesizeinteger

The resource file size in bytes

formatstringrequired

The resource format

idstring

The resource unique ID

last_modifiedstring · date-time

The resource last modification date

lateststring

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.

metricsobject

The resource metrics

mimestring

The resource mime type

preview_urlstring

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

titlestringrequired

The resource title

urlstringrequired

The resource URL

filetypestring · enumrequired

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

Example: file

Options: file, remote

typestring · enumrequired

Resource type (documentation, API...)

Example: main

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

checksumall of

A checksum to validate file validity

harvestall of

Harvest attributes metadata information

internalall of

Site internal and specific object's data

schemaall of

Reference to the associated schema

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/resources/{rid}/' \
  --header 'Content-Type: application/json' \
  --data '{"extras":{},"format":"text","metrics":{},"title":"text","url":"text","filetype":"file","type":"main","checksum":{"value":"text","type":"sha1"},"harvest":{"created_at":"2025-02-20T19:10:52.435Z","modified_at":"2025-02-20T19:10:52.435Z","uri":"text"},"internal":{"created_at_internal":"2025-02-20T19:10:52.435Z","last_modified_internal":"2025-02-20T19:10:52.435Z"},"schema":{"name":"text","url":"text","version":"text"}}'

200

400

200

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  }
}

Success

Delete a given resource on a given dataset

delete

/datasets/{dataset}/resources/{rid}//

Path parameters

ridstringrequired

The resource unique identifier

datasetstringrequired

The dataset ID or slug

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

Success

Checks that a resource's URL exists and returns metadata

get

/datasets/{dataset}/resources/{rid}/check/

Path parameters

ridstringrequired

The resource unique identifier

datasetstringrequired

The dataset ID or slug

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

Success

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

post

/datasets/{dataset}/resources/{rid}/upload/

Path parameters

ridstringrequired

The resource unique identifier

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/resources/{rid}/upload/'

200

400

415

200

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "success": true
}

Success

Upload a file for a new dataset resource

post

/datasets/{dataset}/upload/

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

filestring · binary

uuidstring

filenamestring

partindexinteger

partbyteoffsetinteger

totalpartsinteger

chunksizeinteger

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/upload/' \
  --header 'Content-Type: multipart/form-data'

201

400

415

201

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "success": true
}

Success

Upload a new community resource

post

/datasets/{dataset}/upload/community/

Path parameters

datasetstringrequired

The dataset ID or slug

Header parameters

X-Fieldsstring · mask

An optional fields mask

Body

filestring · binary

uuidstring

filenamestring

partindexinteger

partbyteoffsetinteger

totalpartsinteger

chunksizeinteger

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/{dataset}/upload/community/' \
  --header 'Content-Type: multipart/form-data'

201

400

415

201

{
  "created_at": "2025-02-20T19:10:52.435Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "format": "text",
  "id": "text",
  "last_modified": "2025-02-20T19:10:52.435Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "title": "text",
  "url": "text",
  "filetype": "file",
  "type": "main",
  "checksum": {
    "value": "text",
    "type": "sha1"
  },
  "harvest": {
    "created_at": "2025-02-20T19:10:52.435Z",
    "modified_at": "2025-02-20T19:10:52.435Z",
    "uri": "text"
  },
  "internal": {
    "created_at_internal": "2025-02-20T19:10:52.435Z",
    "last_modified_internal": "2025-02-20T19:10:52.435Z"
  },
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "dataset": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "page": "text",
    "title": "text",
    "uri": "text"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text",
    "badges": [
      {
        "kind": "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

/datasets/{id}/followers/

Path parameters

idstringrequired

Query parameters

pageinteger · default: 1

The page to fetch

page_sizeinteger · default: 20

The page size to fetch

Header parameters

X-Fieldsstring · mask

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//www.data.gouv.fr/api/1/datasets/{id}/followers/'

200

200

{
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1,
  "data": [
    {
      "id": "text",
      "since": "2025-02-20T19:10:52.435Z",
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ]
}

Success

Follow an object given its ID

Returns the number of followers left after the operation

post

/datasets/{id}/followers/

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//www.data.gouv.fr/api/1/datasets/{id}/followers/'

200

200

No body

Success

Unfollow an object given its ID

Returns the number of followers left after the operation

delete

/datasets/{id}/followers/

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '//www.data.gouv.fr/api/1/datasets/{id}/followers/'

200

200

No body

Success