Skip to main content

Overview

Frameworks are the top-level resource — every article, recital, requirement, and annex belongs to one. Use the client.frameworks resource to query them.

Methods

list()

Returns the first page of frameworks.
Parameters
ParameterTypeDefaultDescription
pageint1Page number
per_pageint20Items per page (1–100)
Returns Page[Framework]

get()

Fetch a single framework by its slug.
Parameters
ParameterTypeDescription
slugstrFramework slug, e.g. "gdpr", "cra", "nis2"
Returns FrameworkDetail

iter()

Iterate over every framework across all pages without manual pagination.
Parameters — same kwargs as list() (except page, which is managed internally). Returns Iterator[Framework]

Models

Framework

Returned by list() and iter().
FieldTypeDescription
idintInternal numeric ID
slugstrURL-safe identifier, e.g. "gdpr"
namestrFull official name
short_namestrAbbreviated name, e.g. "GDPR"
celex_numberstr | NoneEUR-Lex CELEX identifier
descriptionstr | NonePlain-text summary
is_activeboolWhether the framework is in force
statusstr"active", "draft", or "superseded"
expected_articlesint | NoneKnown article count from official text
expected_recitalsint | NoneKnown recital count
last_synced_atstr | NoneISO 8601 timestamp of last data sync
created_atstrISO 8601 timestamp of record creation
article_countintArticles currently in the database
recital_countintRecitals currently in the database

FrameworkDetail

Returned by get(). Extends Framework with:
FieldTypeDescription
eurlex_urlstr | NoneCanonical EUR-Lex URL
requirement_countintParsed compliance requirements
annex_countintAnnexes in the database
tag_countintTags applied to this framework’s content
coveragedictSync coverage statistics

Examples

Filter active frameworks only

Inspect a framework’s coverage

Look up a framework by short name

Framework slugs are stable identifiers — safe to hardcode in your application. They will not change between API versions.
Some frameworks have status="superseded" (e.g. NIS1). The data is still accessible and browsable, but these frameworks are no longer in force.