API catalogue of open data - data.gouv.frAPI catalogue des données ouvertes - data.gouv.fr

Name: API catalogue of open data - data.gouv.fr
Creator: data.gouv.fr

API catalogue des données ouvertes - data.gouv.frAPI catalogue of open data - data.gouv.fr

APIDiscovered1/7blocked by verifiedPreviewSubscribe🇫🇷France

This API provides programmatic access to the data.gouv.fr platform, the French government's catalogue of public data. It allows retrieval of metadata and references for datasets submitted by ministries, local authorities, and other public bodies, as well as links to other administrative data catalogues. Maintained by Etalab, the French government's open data and public sector information mission, the API supports discovery and reuse of open datasets published across national and local administrations in France.Le site [data.gouv.fr](https://data.gouv.fr) est le catalogue des données publiques de l'administration. La plateforme permet le dépôt et le référencement de données issues de ministères comme de collectivités locales. Le catalogue contient également des références vers d'autres catalogues d'admini…

government

OpenAPI spec Read the docs

Trust score

How is this computed?

good

Weighted across five axes. Tap a ring for what it measures.

Data schema (116 fields)

Filterable via the API (62)

pagepage_sizeuserorganizationrelated_toidentifiersizecontact_pointsortqtopicreuseownerorganization_badgeaccess_typetagfeatureddatasetdataservicesend_legal_notice_formatidlicensegeozonegranularitytemporal_coveragebadgefollowed_byformatschemaschema_versioncreditarchiveddeletedprivatecommunitybadge_kindridclosedfororgcidxidentstatussourceapi_tokenhandlednotificationnamebusiness_number_idkindwith_draftspostsubject_typereporttypeleveldynamicidsno_maildelete_commentsvisualization

Field	Type	Description
page	integer	Page number to fetch in a paginated result set.The page to fetch
page_sizePage size	integer	Number of items to return per page.The page size to fetch
user	string	Filters results for activities by a specific user.Filter activities for that particular user
organization	string	Filters results for activities by a specific organization.Filter activities for that particular organization
related_toRelated to	string	Filters activities by the related object identifier (e.g. reuse, dataset).Filter activities for that particular object id (ex : reuse, dataset, etc.)
identifier	string	Unique identifier of the resource.Unique identifier of the resource.
size	integer	Size value associated with the resource.Size value associated with the resource.
contact_pointContact point	string	Identifier of the associated contact point.Identifier of the associated contact point.
sort	string	Field and direction used to sort the results.The field (and direction) on which sorting apply
q	string	Free-text search query string.Free-text search query string.
topic	string	Filters results by topic.Filters results by topic.
reuse	string	Identifier of a related reuse.Identifier of a related reuse.
owner	string	Identifier of the owning user.Identifier of the owning user.
organization_badgeOrganization badge	string (my-custom-format)	Filters by an organization badge value.Filters by an organization badge value.
access_typeAccess type	string	Type of access granted to the resource.Type of access granted to the resource.
tag	string	Filters results by a specific tag.Filters results by a specific tag.
featured	boolean	Indicates whether the item is featured.Indicates whether the item is featured.
dataset	string	Identifier of the associated dataset.Identifier of the associated dataset.
dataservice	string	Identifier of the associated dataservice.Identifier of the associated dataservice.
send_legal_noticeSend legal notice	boolean	Whether to send a formal legal notice with appeal information to the owner (admin only).Send formal legal notice with appeal information to owner (admin only)
_format	string	Response format requested for the API call.Response format requested for the API call.
id	string	Unique identifier of the record.Unique identifier of the record.
license	string	Filters results by license identifier.Filters results by license identifier.
geozone	string	Filters results by geographic zone.Filters results by geographic zone.
granularity	string	Geographic or temporal granularity level.Geographic or temporal granularity level.
temporal_coverageTemporal coverage	string	Filters results by temporal coverage period.Filters results by temporal coverage period.
badge	string	Badge type associated with the resource.Badge type associated with the resource.
followed_byFollowed by	string	Identifier of a user following the item (beta, subject to change).(beta, subject to change/be removed)
format	string	File or data format filter.File or data format filter.
schema	string	Identifier of the associated data schema.Identifier of the associated data schema.
schema_versionSchema version	string	Version of the associated data schema.Version of the associated data schema.
credit	string	Credit or attribution associated with the resource.Credit or attribution associated with the resource.
archived	boolean	Filters datasets by their archived status; requires authentication.If set to true, it will filter on archived datasets only. If set to false, it will exclude archived datasets. User must be authenticated and results are limited to user visibility
deleted	boolean	Filters datasets by their deleted status; requires authentication.If set to true, it will filter on deleted datasets only. If set to false, it will exclude deleted datasets. User must be authenticated and results are limited to user visibility
private	boolean	Filters datasets by their private status; requires authentication.If set to true, it will filter on private datasets only. If set to false, it will exclude private datasets. User must be authenticated and results are limited to user visibility
community	string	Unique identifier of the community resource.The community resource unique identifier
badge_kindBadge kind	string	Type of badge to filter by.Type of badge to filter by.
rid	string	Unique identifier of the resource.The resource unique identifier
closed	boolean	Filters discussions by their closed status.Filters discussions on their closed status if specified
for	array	Filters discussions by the subject they concern.Filter discussions for a given subject
org	string	Filters discussions by organization.Filter discussions for a given organization
cidx	string	Internal identifier used for filtering or comparison.Internal identifier used for filtering or comparison.
ident	string	Identifier value used to locate the record.Identifier value used to locate the record.
status	string	Current status of the record.Current status of the record.
source	string	Origin or source of the data.Origin or source of the data.
api_tokenApi token	string	API token used for authentication.API token used for authentication.
handled	boolean	Indicates whether the item has been handled.Indicates whether the item has been handled.
notification	string	Identifier or type of notification.Identifier or type of notification.
name	string	Name of the record.Name of the record.
business_number_idBusiness number id	string	Business identification number (e.g. SIRET/SIREN).Business identification number (e.g. SIRET/SIREN).
kind	string	Type or category of the object.Type or category of the object.
with_draftsWith drafts	boolean	If true, also returns unpublished posts (super-admins only).`True` also returns the unpublished posts (only for super-admins)
post	string	Identifier or slug of the post.The post ID or slug
subject_typeSubject type	string	Type of the subject the record relates to.Type of the subject the record relates to.
report	string	Identifier of a report record.Identifier of a report record.
type	string	Type category of the record.Type category of the record.
level	string	Severity or importance level of the record.Severity or importance level of the record.
dynamic	boolean	Whether to include dynamically generated datasets.Append dynamic datasets
ids	string	Comma-separated list of zone identifiers.A zone identifiers list (comma separated)
no_mailNo mail	boolean	Whether to skip sending the deletion notification email.Do not send the simple deletion notification email. Note: automatically set to True when send_legal_notice=True to avoid sending duplicate emails.
delete_commentsDelete comments	boolean	Whether to delete comments posted by the user upon deletion.Delete comments posted by the user upon user deletion
visualization	string	Identifier or slug of the visualization.The visualization ID or slug
conditionAccessAudience (read)	string	Condition defining the access audience rule.Condition defining the access audience rule.
roleAccessAudience (read)	string	Role associated with the access audience.Role associated with the access audience.
actorActivity	unknown	The user who performed the action.The user who performed the action
changesActivity	array<string>	List of attributes changed by the activity.Changed attributes as list
created_atActivity	string (date-time)	Date and time when the action was performed.When the action has been performed
extrasActivity	object	Additional key-value attributes for the activity.Extras attributes as key-value pairs
iconActivity	string	Icon representing the activity type.The icon of the activity
keyActivity	string	Key identifying the activity type.The key of the activity
labelActivity	string	Human-readable label of the activity.The label of the activity
related_to_idActivity	string	Identifier of the object targeted by the activity.The activity target object identifier
related_to_kindActivity	string	Class name of the object targeted by the activity.The activity target object class name
related_to_urlActivity	string	URL of the model targeted by the activity.The activity target model
dataActivityPage	array<object>	List of items on the current page.The page data
next_pageActivityPage	string	URL of the next page of results, if any.The next page URL if exists
previous_pageActivityPage	string	URL of the previous page of results, if any.The previous page URL if exists
totalActivityPage	integer	Total number of items across all pages.The total paginated items
expires_atApiToken (read)	string (date-time)	Date and time when the token expires.When this token expires
last_used_atApiToken (read)	string (date-time)	Date and time the token was last used.Last time this token was used
revoked_atApiToken (read)	string (date-time)	Date and time when the token was revoked.When this token was revoked
scopesApiToken (read)	array<string>	List of permission scopes granted to the token.Token scopes
token_prefixApiToken (read)	string	First characters of the token used for identification.First characters of the token for identification
user_agentsApiToken (read)	array<string>	List of user agents that used this token.User agents that have used this token
subjectAssignment (read)	object	Object that the assignment refers to.Object that the assignment refers to.
classBaseReference	string	Class name of the referenced object.The object class
consolidation_dataset_idCatalogSchema	string	Identifier of the dataset used for schema consolidation.Identifier of the dataset used for schema consolidation.
contactCatalogSchema	string	Contact information associated with the schema.Contact information associated with the schema.
datapackage_descriptionCatalogSchema	string	Description of the schema within its datapackage.Only present if the schema is inside a datapackage
datapackage_nameCatalogSchema	string	Name of the datapackage containing the schema.Only present if the schema is inside a datapackage
datapackage_titleCatalogSchema	string	Title of the datapackage containing the schema.Only present if the schema is inside a datapackage
descriptionCatalogSchema	string	Description of the schema.Description of the schema.
examplesCatalogSchema	array<object>	List of example data conforming to the schema.List of example data conforming to the schema.
external_docCatalogSchema	string	URL of external documentation for the schema.URL of external documentation for the schema.
external_toolCatalogSchema	string	Link to a tool for creating files with this schema.Link to tools to create a file with this schema
homepageCatalogSchema	string	Homepage URL of the schema.Homepage URL of the schema.
labelsCatalogSchema	array<string>	List of labels associated with the schema.List of labels associated with the schema.
schema_typeCatalogSchema	string	Type category of the schema.Type category of the schema.
schema_urlCatalogSchema	string	URL to the schema, often its latest version.Often the link to the latest version
titleCatalogSchema	string	Title of the schema.Title of the schema.
versionsCatalogSchema	array<object>	List of available versions of the schema.List of available versions of the schema.
pathCatalogSchemaExample	string	File path of the schema example.File path of the schema example.
version_nameCatalogSchemaVersion	string	Name of the schema version.Name of the schema version.
deleted_atChart (read)	string (date-time)	Date and time when the chart was deleted.Date and time when the chart was deleted.
imageChart (read)	string	URL of the chart's image.URL of the image
image_thumbnailChart (read)	string	URL of the chart's thumbnail image.URL of the image
last_modifiedChart (read)	string (date-time)	Date and time the chart was last modified.Date and time the chart was last modified.
metricsChart (read)	object	Metrics data associated with the chart.Metrics data associated with the chart.
permissionsChart (read)	unknown	Permissions granted for the chart.Permissions granted for the chart.
seriesChart (read)	array<object>	List of data series displayed on the chart.List of data series displayed on the chart.
slugChart (read)	string	URL-friendly identifier of the chart.URL-friendly identifier of the chart.
x_axisChart (read)	object	Configuration of the chart's X axis.Configuration of the chart's X axis.
y_axisChart (read)	object	Configuration of the chart's Y axis.Configuration of the chart's Y axis.
valueChecksum	string	The resulting checksum or hash value.The resulting checksum/hash
contact_formContactPoint (read)	string	URL of the contact point's contact form.URL of the contact point's contact form.
emailContactPoint (read)	string	Email address of the contact point.Email address of the contact point.

Schema captured from openapi 1 month ago.

Verification Status

Using the API

Configuration

Base URL: https://www.data.gouv.fr/api/1
Format: openapi

Query examples

curl -s 'https://www.data.gouv.fr/api/1/swagger.json' -H 'Accept: application/json'

Machine-readable API description (use it to generate clients).

Full API documentation ↗

Machine-readable & source

OpenAPI spec JSON

Embed this badge in a README or wiki — it always shows the latest verification state and quality tier.