lexapi (Python)
Official Python SDK for LexAPI — European legal data, made queryable. EUR-Lex, CJEU case law, and the Official Journal behind one REST API.
Covers every documented /api/v1 endpoint (search, documents, point-in-time versions, semantic search incl. asOf, the citation graph, webhooks, bulk export), sync and async, with typed responses, typed errors, retries and credit visibility. Python 3.9+; httpx is the only dependency. See the CHANGELOG.
Version 0.5.0 targets LexAPI API 3.0.0.
Install
pip install lexapi-client
The PyPI distribution is
lexapi-client(same name as npm’s@lexapi/client); the import islexapi—from lexapi import LexAPI.
Quickstart
from lexapi import LexAPI
client = LexAPI(api_key="lex_...") # or set LEXAPI_API_KEY
info = client.get_info() # free (0 credits)
print(info.subscription_info.tier, info.credits_remaining)
Keys come from the LexAPI dashboard and are prefixed lex_ (plans and credit costs). Keep them server-side — never ship them in client-side code.
Search
results = client.search(
"cybersecurity",
author=["court-of-justice"],
year=2024,
document_type="judgment",
max_pages=1, # 3 credits per page, tier-clamped, unfetched pages refunded
)
for hit in results.results:
print(hit.celex, hit.document_type_code, hit.title)
# Capping and fallbacks are surfaced, never hidden:
if results.truncated:
print("tier-capped:", results.truncated_reason)
if results.partial:
print("partial answer:", results.partial_reason)
if results.post_filtered_by:
print("server-side post-filter fired on:", results.post_filtered_by)
print(results.source) # "soap" | "cellar" | "corpus" | None (EUR-Lex result pages)
print(results.cache) # "hit" | "miss" | "bypass" — 60-minute result cache, same price
client.search(
"*", date_from="2026-10-01", date_to="2026-10-25", fresh=True
) # filter-only, bypass cache
Documents
resp = client.get_document("32016R0679", language="fr")
doc = resp.document
print(
doc.title, doc.date_of_document_iso, resp.source
) # source: corpus | cellar | cellar-oj | live
if doc.content: # None when the text is not available (below)
for article in doc.content.articles[:3]:
print(article.number, article.title)
# Notice published but no text: a 200 with content=None (billed 1 credit, not 5)
if resp.text_available is False:
ta = doc.text_availability
print(ta.reason, ta.retryable, ta.available_languages) # None = unknown, [] = none
if ta.latest_consolidated: # base acts: pointer to CONSLEG
print("try", ta.latest_consolidated.celex)
# In force today (API 2.19.0) and where the document comes from (API 2.20.0)
print(doc.in_force, doc.not_in_force_reason, doc.end_of_validity) # None = unknown
if doc.provenance: # None before API 2.20.0
print(doc.provenance.source_url, doc.provenance.licence, doc.provenance.content_hash)
# Title not in the requested language? titleLanguage says which language it is in
print(doc.title_language)
# Authentic text in another language in one call (most General Court decisions have no English)
resp = client.get_document("62019TJ0001", accept_languages=["fr", "de"]) # or "any"
print(resp.document.language, resp.document.language_fallback)
# Trim the payload: only metadata + one article
resp = client.get_document("32016R0679", include=["metadata", "articles"], article_id="17")
# Batch — per-CELEX failures don't abort the batch
batch = client.get_documents_batch(["32016R0679", "62018CJ0311"])
print(batch.successful, "ok /", batch.failed, "failed /", batch.text_unavailable, "without text")
print(batch.corpus_hits, batch.cellar_served, batch.oj_recovered, batch.live_fetches)
if batch.trimmed: # tier ceiling hit — mirrored from X-Warning too
print(batch.trimmed_reason)
recent = client.get_recent_documents(
days=3, document_type="regulation"
) # one type; author may be a list
print(recent.source) # "cellar" (unfiltered: 3 credits flat) or "live" (per page)
by_url = client.get_document_by_url(
"https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX:32016R0679"
)
meta = client.get_document_metadata("32016R0679").metadata # no body parse
celex = client.resolve("ECLI:EU:C:2020:559").celex # CELEX/URL/ELI/ECLI → CELEX
# .resolved_via: celex / url / ecli-corpus / eli-corpus / eli-cellar / eli;
# .verified False = not confirmed by a lookup (None on older servers)
Typed responses stay mapping-compatible (results["totalResults"] works) and
every typed model keeps the raw payload on .raw.
Semantic search
# Case law (CJEU) — concept queries, similarity-ranked (5 credits)
resp = client.semantic_search(
"transfer of personal data to third countries",
min_score=0.5, # widen recall past the ~0.7 default relevance floor
limit=10,
)
for hit in resp.results:
print(f"{hit.score:.2f}", hit.celex, hit.case_number, hit.case_name, hit.snippet)
if resp.hint: # present only on low-confidence (best-effort) responses
print(resp.hint)
# A snippet is the head of the machine-written summary when the hit has one (not court
# text), else of the matched text. include_text=True: the full text of each hit LexAPI
# holds (API 2.30.0). A hit without it has text_availability.available False, a reason
# ("not_in_corpus" | "unknown") and keeps its snippet; read the text with get_document.
resp = client.semantic_search("adequacy decision", include_text=True)
for hit in resp.results:
ta = hit.text_availability
if ta and not ta.available and hit.celex:
print(hit.celex, ta.reason) # then: client.get_document(hit.celex)
# HyDE query rewriting for terse/keyword queries — 15 credits instead of 5
resp = client.semantic_search("credit scoring article 22", hyde=True)
print(resp.hyde) # False means the LLM fell back — premium auto-refunded
print(resp.units_charged) # 15 when HyDE ran, 5 after a fallback
print(resp.hypothetical_document) # the LLM-drafted passage (when HyDE ran)
# Legislation — article-level matches (HyDE is case-law only; limit capped at 50)
laws = client.semantic_legislation_search("right to be forgotten", limit=5)
for hit in laws.results:
print(hit.law_id, hit.article_ref, hit.law_title)
if hit.consolidated: # merged hit: consolidated text + the authentic act's own match
print(" consolidated as of", hit.consolidated_as_of, "— cite", hit.base_celex)
print(" ", hit.consolidated_note)
# Only acts known to be in force today (sent as the top-level inForce)
current = client.semantic_legislation_search("right to be forgotten", in_force=True)
if current.in_force_filter: # None before API 2.19.0
print(current.in_force_filter.removed_not_in_force, current.in_force_filter.removed_unknown)
| Field (documents and legislation hits) | Meaning |
|---|---|
in_force, not_in_force_reason, end_of_validity, entry_into_force |
Whether the act is in force today (UTC), as recorded by the Publications Office; all None when unknown. A consolidated text or corrigendum carries the label of its act. Not about amendments, nor about an as_of date (API 2.19.0) |
provenance (Provenance) |
publisher, source_url, source_identifier, retrieved_at, content_hash, version_identifier, language, licence; None values are not known. On search hits retrieved_at and content_hash are None (API 2.20.0) |
field_provenance (FieldProvenance) |
Which fields are the publisher's text (official_source_text) and which were derived (API 2.20.0) |
Document.version |
LexAPI's snapshot number of the text |
SemanticLegislationResponse.in_force_filter |
With semantic_legislation_search(..., in_force=True) (sent as the top-level inForce, not in filters): removed_not_in_force, removed_unknown |
get_info().subscription_info.max_semantic_results / .max_semantic_legislation_results |
The most results one semantic search returns on your plan (API 2.24.0) |
The text in force on a date (as_of)
import datetime
laws = client.semantic_legislation_search("own funds requirements", as_of="2019-06-01")
# pass a date or a YYYY-MM-DD string; a datetime is cut to its own calendar date, not converted to UTC
print(laws.as_of, laws.as_of_summary.live_fetches, laws.as_of_summary.unresolved)
for hit in laws.results:
if hit.as_of_resolved:
v = hit.as_of_version # kind: "consolidated" | "as_published"
print(hit.law_id, hit.article_ref, v.kind, v.date)
if hit.matched_version: # the text was swapped for the version in force
print(" index matched", hit.matched_version.law_id)
else:
print(hit.law_id, "kept its latest text:", hit.as_of_reason) # see lexapi.AS_OF_REASONS
Each hit is checked for being in force on that date and answered with the act
as published before its first consolidation, otherwise the consolidated version
in force. Cost: 5 credits for the search; each version the corpus doesn't hold
is fetched live (at most 3 per request by default) and settles at 4 (Cellar),
5 (browser), 1 (no text) or 0 (failed / timed out). A fetch the pool can't
cover is skipped (as_of_reason == "insufficient_credits") — only the search
itself can raise CreditsExhaustedError. An invalid date is a 400
(InvalidParamsError, refunded). Pass a date or a YYYY-MM-DD string; a
datetime is cut to its own calendar date, not converted to UTC.
One act on a date (legislation_as_of)
answer = client.legislation_as_of("32016R0679", "2019-06-01", provision="art_17")
if answer.as_of_resolved:
v = answer.as_of_version # kind: "consolidated" | "as_published"
print(v.celex, v.kind, v.date)
print(answer.provision.number, answer.provision.text)
# no legal force — cite the authentic act (answer.document is always the act)
if answer.consolidated:
print("cite", answer.base_celex)
else:
print("not established:", answer.as_of_reason) # see lexapi.AS_OF_LOOKUP_REASONS
The version of an EU regulation, directive or decision listed for a date: the
newest consolidated version dated on or before it, or the act as published in
the Official Journal. provision adds one article, annex (anx_III) or recital
range (rct_26-28); omit it for the version only. legislation_as_of reads one
act you already know by CELEX number; semantic_legislation_search(as_of=...)
is the search by meaning. Needs LexAPI API 2.26.0.
- Unresolved. An answer that cannot be established is a normal return with
as_of_resolved == Falseand anas_of_reason— use the text only whenas_of_resolvedis true. Unresolved answers are returned, not raised, so a retry loop has to look atas_of_reason: thefetch_*reasons,request_deadline,version_list_unavailableandversion_lookup_capare worth asking again; the others are the answer for that date. - To cite.
answer.documentis always the act itself;answer.as_of_version.celexand.datename the version the text comes from (base_celexis set on consolidated answers only). - Dates.
answer.as_of_version.valid_until, when set, is the last day this version is the one listed.answer.act.in_force_todayis about today, not aboutas_of. An amendment that applies retroactively counts from the date of the amending act. The answer does not say whether an individual provision applied on that date. - Input. Send the bare CELEX number: a
CELEX:prefix is a 400 (InvalidCelexError). - Errors. An unknown act raises
NotFoundError; invalid input raisesInvalidCelexError/InvalidParamsError. An API older than 2.26.0 has no such endpoint and also answers 404 (NotFoundError).err.unknown_endpointis False there (the API sends it from 2.27.0): checkerr.message.startswith("Unknown API endpoint"). - Cost. 1 credit when no text is fetched; when the provision's text has to
be fetched, 4 (5 when it is fetched live from EUR-Lex), whatever the answer,
and 1 if the fetch fails or finds no text. A fetch reserves up to 5 credits:
a pool holding fewer gets
as_of_reason == "insufficient_credits".
Passages for RAG frameworks
lexapi.passages turns responses into framework-neutral passages: a text
together with the citation it must be shown with. It makes no request of its
own and imports no framework, so an adapter for any RAG framework can be built
on it.
from lexapi import LexAPI, passages
with LexAPI() as client:
response = client.semantic_legislation_search(
"right to erasure", as_of="2019-06-01", include_text=True
)
result = passages.from_legislation_search(response, as_of="2019-06-01")
for p in result.passages:
# for an act as published: CELEX 32016R0679, art_17, version for 2019-06-01: 32016R0679
print(passages.format_citation(p))
print(p.content()) # the text, or a one-line notice when there is none
print(result.withheld, "withheld;", result.units_charged, "credits")
- Unresolved text is withheld. On an
as_ofsearch, a hit the API could not answer for that date comes back with its latest indexed text. That text is not established as the text for the date, so the passage is kept withtext=None(text_status == "withheld") and itsas_of_reason;content()is then a notice such as[No text: CELEX 31995L0046 art_12 is not established as the text for 2019-06-01 (reason: fetch_timeout).].unresolved="drop"leaves such hits out and counts them inresult.dropped;unresolved="keep_labelled"keeps the latest text, markedtext_status == "not_established_for_date". Only the passages are filtered:response.resultsstill holds the latest text of unresolved hits. - Citation. Every passage has a
celex;cite_celexis the number to cite. A consolidated text hasconsolidated=Trueand, when the API names it,base_celex: consolidated texts have no legal force, so cite the act as published in the Official Journal. When the API does not name that act (a document read),cite_celexisNone. - Nothing is guessed. A field the API did not send is
None. A text that is empty or holds only whitespace or invisible format characters (such as a zero-width space) counts as no text:text=None,has_textFalse. - Converters.
from_legislation_search,from_case_law_search,from_document(one passage per article) andfrom_legislation_as_ofeach return aPassageResult:passages, thewithheld/droppedcounts,as_of, andunits_charged/credits_remainingas the response reports them, once per call. They take the EU responses only; national search responses (client.national.*) are not supported. - For a framework.
p.metadata()is the citation as a flat dictionary (never the text),p.idan identifier that is stable across calls and differs between dates, andpassages.format_passage(p)the content followed by aSource:line. - One act only. The legislation index reads no
filterskey exceptlanguage;passages.restrict_to_celex(result, "32016R0679")keeps the passages of that act and its consolidated texts after the search.
Citations
The typed citation graph lives under client.citations:
client.citations.extract("32016R0679") # crawl + persist edges (5 credits, 1 if already done)
inbound = client.citations.cited_by("32008R1272", citation_type="corrigendum", limit=50)
print(inbound.total_edges, "edge rows;", inbound.total_citations, "document pairs")
print(inbound.counts_source) # "stats" or "counted" — both exact for the request
print(inbound.relation_sync.status) # Cellar refresh state of amendment/corrigendum/repeal edges
for group in client.citations.iter_cited_by("32008R1272"): # every edge page (1 credit each)
print(group.celex_number, group.citation_count)
outbound = client.citations.cites("32016R0679")
network = client.citations.network("32016R0679", limit=100) # 20 credits
if network.partial: # server-side budget expired — 200, not an error
print(network.message)
path = client.citations.path("32016R0679", "31995L0046", max_depth=4)
if path.found:
print(" -> ".join(node.celex_number for node in path.path))
related = client.citations.related("32016R0679", limit=10) # bibliographic coupling
stats = client.citations.stats()
print(stats.most_cited[0].celex_number)
# National documents in the graph (BUSINESS, SCALE, ENTERPRISE only — TierForbiddenError below that):
with_national = client.citations.cited_by("32016R0679", include_national=True)
print(with_national.include_national) # present once honoured; None while no jurisdiction is live
national_edges = client.citations.cites("AT-NOR-10001597") # a national id works directly
Page iterators. citations.iter_cited_by / iter_cites yield every
document group, webhooks.iter_deliveries every delivery and
national.iter_documents every page, as the pages arrive.
- Edge walks (
iter_cited_by,iter_cites) end at an empty page, at a page shorter than the echoedlimit(when that is a positive integer; else than the requestedpage_size), or once the offset reachestotal_edges. They raiseInvalidResponseErrorwhen the server echoes anotheroffsetthan the one asked for, and — only on answers that carry neithertotalEdgesnor an echoedoffset— on the third page in a row equal to the page before. - Deliveries (
iter_deliveries) end at an empty page or once the offset reachestotal. Only when the answer has no usabletotal(whatever else it echoes), the walk raises on the third page in a row that brings no delivery not seen yet. - National documents (
iter_documents) end after a page without a next cursor (or withhas_morenot true, or no results), and raise when the server hands back a cursor already sent in the walk, or one that is not a string while the walk would continue.
Everything yielded before an error stays valid; the page that showed the
stall is not yielded and is on err.body.
Every edge says where it comes from (provenance) and how its target was
identified (resolution, national edges only); every node carries id,
jurisdiction and document_kind. The edge reads (cited_by, cites,
network, path, related) filter on citation_type, provenance,
jurisdictions and resolution — each one value or a list, sent
comma-separated. An unknown value raises InvalidParamsError with .param
and .allowed (refunded):
amendments = client.citations.cited_by(
"32016R0679",
citation_type=["amendment", "repeal"],
provenance=["cellar", "notice+cellar"],
)
for group in amendments.cited_by:
for edge in group.citations:
print(group.id, group.jurisdiction, edge.citation_type, edge.provenance)
network = client.citations.network("32016R0679")
for neighbour in network.cites:
print(neighbour.id, [(d.citation_type, d.provenance) for d in neighbour.edge_details])
# National edges (BUSINESS+): only id/key matches, from Austria and the EU,
# plus the references that could not be resolved.
outbound = client.citations.cites(
"AT-NOR-10001597", jurisdictions=["eu", "at"], resolution=["id", "key"], unresolved=True
)
for ref in outbound.unresolved or []:
print(ref.kind, ref.text, ref.status)
Notified measures (transposition, 5 credits, every plan). The
measures the member states notified to the Commission for an EU act, by
country. A notification is not a finding that the measure transposes the
act, or transposes it completely — show note with the measures and keep
source_cellar.attribution with anything you republish. On BUSINESS,
SCALE and ENTERPRISE the live jurisdictions also say which measures LexAPI
holds (id, resolved, resolution); below that those fields are None.
measures = client.citations.transposition("32016L0680", jurisdictions=["es", "cz"])
print(measures.note)
for country in measures.jurisdictions:
for m in country.measures:
print(
country.jurisdiction, m.title, m.official_journal.date if m.official_journal else None
)
held = client.citations.transposition("32016L0680", resolved_only=True) # BUSINESS+
Counterparts (counterparts, 20 credits, BUSINESS and above). A
national document's counterparts in the other live jurisdictions, through
the EU acts it transposes or implements, ranked 1 (the national source
records the relation), 2 (a notified measure LexAPI holds) or 3 (a notified
measure LexAPI does not hold). A lookup past its server-side budget raises
TimeoutError (.partial, refunded). The SDK does not retry it, because
re-running waits the full budget again; narrow it with jurisdictions:
result = client.citations.counterparts("AT-NOR-10001597", jurisdictions=["si", "cz"])
for via in result.via:
print(via.eu_act.id, via.eu_act.notified_measures)
for c in via.counterparts:
print(" ", c.rank, c.jurisdiction, c.id, c.title)
cited_by, cites, network, path, related and stats all accept
include_national=True to also return/follow national documents of live
jurisdictions (BUSINESS, SCALE and ENTERPRISE only). celex (and path's
from_celex/to_celex) may be a national document id directly, with or
without the flag; such an id whose jurisdiction isn't live raises
NotFoundError.
Webhooks
# New documents matching criteria, a watch list of acts, or both.
# The secret is returned ONLY on create — store it to verify X-Webhook-Signature.
created = client.webhooks.create(
"Chemicals compliance watch",
"https://example.com/webhooks/lexapi",
{"documentType": "regulation", "query": "chemical"}, # documents.new (optional)
watch_celex=["32006R1907", "32008R1272"], # watchlist.changes (optional)
)
secret = created.webhook.secret
hooks = client.webhooks.list()
hook = client.webhooks.get(created.webhook.id) # incl. 20 recent deliveries + retry_policy
print(hook.webhook.criteria_errors) # stored criteria a newer rule rejects
resp = client.webhooks.update(hook.webhook.id, status="ACTIVE") # resets failures, re-queues
print(resp.requeued_deliveries)
client.webhooks.update(hook.webhook.id, watch_celex=["32008R1272"], remove_search_criteria=True)
result = client.webhooks.test(hook.webhook.id) # synchronous test delivery
if not result.ok: # HTTP 200 either way
print(result.delivery.error_message)
for delivery in client.webhooks.iter_deliveries(hook.webhook.id): # every page, deduped on id
print(delivery.status, delivery.response_status)
client.webhooks.delete(hook.webhook.id)
Verifying a delivery in your endpoint (pass the raw request body bytes):
from lexapi import WebhookSignatureError, verify_webhook
def handle_delivery(raw_body: bytes, signature: str) -> int:
try:
event = verify_webhook(raw_body, signature, secret) # 5-minute replay window;
# tolerance=None switches the replay window off
except WebhookSignatureError as err:
# err.reason: missing_signature, invalid_signature, malformed_body,
# stale_timestamp (missing_secret is a configuration error)
return 400 if err.reason == "malformed_body" else 401
if event["event"] == "watchlist.changes":
for change in event["data"]["changes"]:
print(change["watchedCelex"], change["relation"], change["document"]["celex"])
# dedupe side effects on event["delivery"]["id"] — stable across retries
return 200
National law
National jurisdictions (member states, and non-EU legal orders such as the UK) live under client.national. Call coverage()
first — a jurisdiction that has not launched yet answers every other national
method with NotFoundError, exactly like one that does not exist (and like
a path the API does not have: err.unknown_endpoint is True, API 2.27.0+):
coverage = client.national.coverage() # public, free
for j in coverage.jurisdictions:
if j.live:
print(j.code, j.name, j.legislation.documents, j.case_law.courts)
for source in j.sources:
print(source.name, source.licence, source.attribution) # show this to users
doc = client.national.get_document("AT", "AT-NOR-10001597").document
print(doc.title, doc.attribution) # always show attribution
for article in doc.content.articles if doc.content else []:
print(article.number, article.title, article.text or "(no text)")
page = client.national.list_documents(
"AT", q="Datenschutz", limit=20
) # document_type is the source's own label (German for RIS), not an EU-style enum
print(page.total, page.total_exact, [d.title for d in page.results])
for p in client.national.iter_documents(
"AT", q="Datenschutz", limit=100
): # cursor paging past page's 1,000-row ceiling
print(p.has_more, p.next_cursor)
hits = client.national.semantic_search("AT", "data breach notification duty")
for r in hits.results:
print(r.document_id, r.score, r.attribution, r.document.ecli, r.document.date_of_document)
legislation_hits = client.national.legislation_semantic_search("AT", "right to erasure")
as_of on national legislation search (requires LexAPI API 2.29.0). The
search runs over today's texts only, and each hit is labelled for the date:
from lexapi import NationalAsOfVersion
hits = client.national.legislation_semantic_search(
"AT",
"Recht auf Auskunft über eigene Daten",
as_of="2020-06-01", # or a date; a datetime is cut to its own calendar date (no UTC conversion)
)
print(hits.as_of, hits.as_of_summary.unresolved)
for hit in hits.results:
v = hit.as_of_version
if hit.as_of_resolved and isinstance(v, NationalAsOfVersion):
print(hit.article_ref, v.valid_from, v.valid_to, v.source_id, v.checked_at)
else:
print(hit.article_ref, "not established for the date:", hit.as_of_reason)
| Field | Meaning |
|---|---|
as_of, as_of_resolved |
On every hit of an as_of search |
as_of_version (NationalAsOfVersion, kind == "current_unit") |
On a resolved hit: valid_from / valid_to (the publisher's dates for today's wording; valid_to None when open), source_id (the publisher's id of the provision), checked_at (YYYY-MM-DD, the day of the last read of the act that LexAPI recorded) |
as_of_reason |
On an unresolved hit; one of lexapi.NATIONAL_AS_OF_REASONS: provision_amended_since, no_longer_in_force, provision_dates_unknown, asof_not_available |
response.as_of, response.as_of_summary |
The date echoed; unresolved counts the unresolved hits (live_fetches is always 0) |
A hit is resolved only when the publisher's dates, as of LexAPI's last recorded
read of the act (checked_at), show today's wording already applied on the
date; a change the publisher made after that read is not reflected. The text is
never swapped for an earlier one: a provision repealed or replaced since the
date cannot be found, and an unresolved hit keeps today's wording, which is not
established as the text for the date. LexAPI holds such dates for Austria and
Spain; for the other countries every hit is asof_not_available. in_force
and the inForce filter are still about today. Dates from 1800-01-01; an
invalid date is a 400 (InvalidParamsError, nothing charged). Same cost: 5
credits.
One shape for every country (requires LexAPI API 2.8.0). National
documents have the same fields, types and formats in every jurisdiction, so
code written for one country works for all of them. Every field is always
present — one the source does not provide is None (or []):
document_kind("act"|"decision";is_act/is_decision) tells legislation from case law everywhere;document_typeis the source's own label, in its language.decision(NationalDecision) — on a decision,court,chamber,case_numbersandcited_norms(NationalCitedNorm:text,document_id), read server-side from whichever fields the source uses (also when the decision has no text);Nonefor acts.content(NationalDocumentContent, orNonewhen there is no text — seetext_availability):full_text,articles(NationalArticle:number,title,section,text—Nonewhen the source publishes no text for that unit —in_force_from,in_force_to,details),text_languages,text_language,embedded_foreign_text,repeal,sourceanddetails. What a source adds beyond these fields is undercontent.details/article.details— source-specific, keys differ by country.- Semantic hits carry
document(the listing's summary of the matched document); legislation hits always carrylaw_title,article_ref,section,language,in_force,valid_from,valid_toandlaw_type,Nonewhen the index has nothing.
d = client.national.get_document("DE", "DE-JUD-BFH-KBRE202550123").document
if d.is_decision and d.decision:
print(d.decision.court, ", ".join(d.decision.case_numbers)) # BFH 3. Senat III R 27/24
for norm in d.decision.cited_norms:
print(norm.text, norm.document_id or "(not identified)")
Pricing below BUSINESS (FREE, STARTER, PROFESSIONAL): each call to the four
non-coverage methods above also draws from a monthly allowance of national
calls (FREE 30, STARTER 500, PROFESSIONAL 2,000 per UTC month). A used-up
allowance raises NationalAllowanceExhaustedError (402) with jurisdiction,
limit, remaining, resets_at and upgrade_url, before any credit is
charged; BUSINESS and above have no separate limit. Every response from
these methods exposes response.national_allowance_limit /
national_allowance_remaining / national_allowance_resets_at (present
only for FREE/STARTER/PROFESSIONAL).
from lexapi import NationalAllowanceExhaustedError
try:
client.national.get_document("AT", "AT-NOR-12345")
except NationalAllowanceExhaustedError as err:
print(err.limit, err.remaining, err.resets_at, err.upgrade_url)
The two semantic_search / legislation_semantic_search methods also raise
NationalSemanticNotEnabledError (409 — this jurisdiction's index doesn't
search yet) and NationalSemanticUnavailableError (503 — temporarily down,
a ServiceUnavailableError); both expose .jurisdiction and charge nothing:
from lexapi import NationalSemanticNotEnabledError, NationalSemanticUnavailableError
try:
client.national.semantic_search("AT", "Datenschutz")
except NationalSemanticNotEnabledError as err:
print(f"{err.jurisdiction} semantic search isn't enabled yet")
except NationalSemanticUnavailableError as err:
# Catch this specific subclass, not the broader ServiceUnavailableError
# it extends — a plain EU 503 has no .jurisdiction attribute.
print(f"{err.jurisdiction} semantic index is temporarily down, retry later")
Incomplete national searches. When the national index could not complete
a semantic search, results may be incomplete. With hits left, the response
has partial (True), partial_reason ("SEARCH_INCOMPLETE") and a hint
(retry, or rephrase / change the filters). With nothing left to return the
call raises instead: NationalSemanticUnavailableError (503,
partial_reason == "SEARCH_INCOMPLETE", retry_after when a retry may help —
retried at most once per call, only with retry_read_only_posts; without a
wait the same search has repeatedly come back incomplete and is not retried
automatically) or NationalSemanticFilterUnreachableError (422, an
InvalidParamsError with .jurisdiction / .partial_reason — a coverage
limit, not a malformed request: the request may be valid and .param is
None; not retryable as is: rephrase the query or change the filters). Both are
refunded; an empty answer would not have meant "no matches".
from lexapi import NationalSemanticFilterUnreachableError
try:
hits = client.national.legislation_semantic_search("DE", "Haftung")
if hits.partial:
print(hits.hint) # results may be missing better matches
except NationalSemanticFilterUnreachableError:
... # rephrase the query or change the filters
include_national on the citation-graph methods and national ids on
/citations/* are implemented — see Citations above.
coverage() also reports each live jurisdiction's measured citation graph
(citation_graph: extraction methods, edges, resolution rates,
precision, floors; a rate that is not measured is None and its reason
is in methods.unmeasured).
Since 2026-11-12 the national-source terms apply to every account, so the API
no longer refuses national requests for terms not accepted.
NationalTermsNotAcceptedError (403; .accept_url, .terms_url,
.terms_version) stays in the SDK and is raised only if the API answers
NATIONAL_TERMS_NOT_ACCEPTED again.
get_document (and the citation methods, for a withdrawn national id)
raise DocumentWithdrawnError (410) for a document its source withdrew —
nothing of it is served, not even the title; drop any copy you hold:
from lexapi import DocumentWithdrawnError
try:
client.national.get_document("AT", "AT-NOR-5")
except DocumentWithdrawnError as err:
print(err.id, err.jurisdiction, err.withdrawn_at)
Corpus export (BUSINESS, SCALE, ENTERPRISE)
export() streams NDJSON rows with constant memory; the _meta / _done
envelopes and export headers are exposed on the stream.
Billing (credit plans, API 2.3.0): 1 credit per row written, at least 1 per
export. The call is admitted for 1 credit, the matching rows are counted, and
the rest of 1 credit per row it can return is reserved; a pool that cannot
cover it raises CreditsExhaustedError before anything streams. Unwritten
rows are refunded when the stream ends: stream.done["credits"]["charged"].
Filters: document_type matches the stored label exactly, ignoring case;
document_type_code="regulation" selects the family (incl. implementing and
delegated regulations); author matches whole values; date_from / date_to
are YYYY-MM-DD; changed_since returns rows whose text changed (the
cheapest incremental sync) and fetched_since rows written to at all — both an
ISO date or a timezone-aware date-time (a naive datetime raises
ValueError); limit is a positive integer.
with client.export(document_type_code="regulation", date_from="2024-01-01", limit=10_000) as stream:
print(stream.total, stream.streaming) # X-Export-Total / X-Export-Streaming
for row in stream: # one dict per corpus row
ingest(row["celex"], row.get("parsedContent"))
print(stream.meta) # leading _meta envelope
print(stream.written, stream.truncated, stream.skipped_stubs) # _done trailer
# Metadata-only rows (no text) are skipped unless include_stubs=True.
# A connection drop mid-stream raises LexAPIConnectionError / RequestTimeoutError,
# and a body that ends without its _done trailer raises IncompleteExportError
# (after yielding the rows that arrived) — a cut-short export never looks complete.
# Async
async with await client.export(fetched_since="2026-06-01T00:00:00Z") as stream:
async for row in stream:
ingest(row)
Licensing: using exported content to train, fine-tune or evaluate ML models needs a separate licence (Terms §6). For training data, Arieta Data, a sister product from Arieta Labs, licenses datasets drawn from the same corpus for training, retrieval and evaluation.
Point-in-time versions
Versions are LexAPI observation snapshots — the document as fetched — not
legal in-force reconstructions; history begins at first ingestion. (For the
version of an act listed for a date, use legislation_as_of(...); to search
the text in force on a date, semantic_legislation_search(as_of=...); or read
a consolidated CELEX such as 02016R0679-20180524.)
from lexapi import NotFoundError
history = client.list_document_versions("32016R0679")
print(history.current_version, history.tracked_since)
for v in history.versions:
print(v.version, v.observed_from, v.fetched_at, "(current)" if v.is_current else "")
snapshot = client.get_document_version("32016R0679", 2)
print(snapshot.document.parsed_content, snapshot.document.provenance.content_hash)
try:
at = client.get_document_at_date("32016R0679", "2026-04-01") # or a datetime.date
print(at.kind, at.as_of, at.document.version) # kind: "observation_snapshot"
print(at.document.observed_from, at.document.observed_until) # until: None = current
if at.date_in_future:
print("a future date: this is the current version")
except NotFoundError as err:
if err.before_tracking:
print("history starts", err.tracked_since)
elif err.boundary_unknown: # refunded
for c in err.candidates: # read them with get_document_version
print(c.version, c.observed_from, c.fetched_at)
| Field (API 2.28.0) | Meaning |
|---|---|
VersionEntry.observed_from |
When the version began; None when LexAPI has no record of it |
VersionEntry.fetched_at |
When the version's text arrived at LexAPI; for a version without observed_from (possible for snapshots stored before API 2.28.0) the last fetch of its text, which is not when the version began |
VersionEntry.observed_until |
get_document_at_date only: when the next version's text arrived; None for the current version |
kind, date_in_future, in_force_lookup |
get_document_at_date only: always "observation_snapshot"; True for a date after today (UTC), answered with the current version; a pointer to legislation_as_of for an EU act it resolves |
NotFoundError.reason |
"before_tracking" (.before_tracking, .tracked_since, .in_force_lookup) or "boundary_unknown" (.boundary_unknown, .candidates of SnapshotCandidate: version, fetched_at, observed_from; at most 10, .candidates_truncated beyond; can be empty) |
get_document_at_date returns the snapshot LexAPI held at the end of that day
(UTC) — LexAPI's fetch history, not the law in force on the date. Each call
costs 1 credit; a 404 costs 1 credit, except boundary_unknown, which is
refunded. A document that is not in the corpus is a 404 without a reason.
Async
Every operation is also available on the async client:
import asyncio
from lexapi import AsyncLexAPI
async def main():
async with AsyncLexAPI() as client: # LEXAPI_API_KEY from the env
info = await client.get_info()
laws = await client.semantic_legislation_search("own funds", as_of="2019-06-01")
async for group in client.citations.iter_cited_by("32008R1272"):
print(group.celex_number)
asyncio.run(main())
Credit visibility
Every response wrapper exposes the credit envelope without losing access to the raw body:
resp = client.get_document("32016R0679")
resp["credits"] # raw body access still works (Mapping)
resp.units_charged # credits this request cost after settlement (1 from the corpus)
resp.credits_remaining # credits.remaining, falling back to usage.remaining
resp.resets_at # ISO-8601 timestamp of the next monthly reset
resp.credits # full typed CreditsInfo (None on legacy daily-call accounts)
resp.subscription_info # typed subscription block (tier, max_pages, max_results, ...)
resp.rate_limit_remaining # RateLimit-Remaining (also rate_limit_limit / rate_limit_reset)
Refunds for failed requests (4xx in full, 404 down to 1, 5xx in full) are applied just after the response is sent, so the next call reflects them.
Typed errors
All non-2xx responses raise a typed exception mirroring the API's stable
error-code enum (both the typed envelope and the legacy bare {"error": ...}
shape are handled; a legacy body's details list is kept on err.details):
from lexapi import (
LexAPIError, # base — code / message / status / details / body / retry_after
NotFoundError, # 404 NOT_FOUND — .unknown_endpoint (API 2.27.0+): the API has no such endpoint;
# .reason / .before_tracking / .boundary_unknown / .candidates (get_document_at_date, API 2.28.0+)
InvalidCelexError, # 400 INVALID_CELEX
InvalidParamsError, # 400 INVALID_PARAMS (e.g. an invalid as_of)
RateLimitedError, # 429 — .retry_after; code QUOTA_EXHAUSTED / .quota_exhausted / .resets_at on legacy quotas
CreditsExhaustedError, # 402 CREDITS_EXHAUSTED — .resets_at, .operation, .weight, .available
TierForbiddenError, # 403 TIER_FORBIDDEN — .upgrade_url on legacy tier gates
PaymentPastDueError, # 403 PAYMENT_PAST_DUE (a TierForbiddenError) — .billing_url, .access_ended_at
UpstreamError, # 502 UPSTREAM_ERROR
TimeoutError, # 504 TIMEOUT (server-side upstream timeout, retry-safe)
AuthenticationError, # 401 — missing/invalid/deactivated key
RequestTimeoutError, # the SDK's own timeout elapsed
ServiceUnavailableError, # 503 (SDK code SERVICE_UNAVAILABLE; subclass of UpstreamError)
InvalidResponseError, # a 2xx that is not the documented shape (e.g. a proxy's HTML page)
IncompleteExportError, # export stream ended without a complete _done trailer
)
try:
client.semantic_search("credit scoring")
except CreditsExhaustedError as err:
print(f"need {err.weight}, have {err.available}; resets {err.resets_at}")
except RateLimitedError as err:
print(f"rate limited, retry in {err.retry_after}s")
except PaymentPastDueError as err:
print(f"payment past due; pay the open invoice: {err.billing_url or 'in the dashboard'}")
except LexAPIError as err:
print(err.code, err.status, err.message)
PaymentPastDueError: a subscription payment failed and was not completed in
time; pay the open invoice in the dashboard (err.billing_url). It is not
retryable. It is a subclass of TierForbiddenError: before API 2.27.0 a failed
payment was refused at once with a 403 without a code, raised as
TierForbiddenError, so an except TierForbiddenError handler keeps catching
it. To tell a failed payment from a plan gate, put the PaymentPastDueError
clause before the TierForbiddenError one.
A JSON body (or export line, or webhook body) nested deeper than 512 levels is refused before it is parsed, on every Python version, and counts as not JSON. In a thread whose stack is far smaller than the default, the interpreter itself can run out of stack before any check runs; the SDK cannot detect that.
InvalidResponseError: a 2xx answer that is not the documented shape — no
body, a body that is not strict UTF-8 JSON (e.g. a proxy's HTML page), JSON
that is not an object, success: false, a documented field that is missing or
of the wrong kind (e.g. document on a document read), or a list such as
results that is missing where the endpoint always sends it, is not a list, or
holds items that are not objects. It is raised so that such an answer is never
read as an empty result: catch it to tell the two apart. Unknown extra fields
are accepted. A success: false answer that carries the API's error envelope
raises the mapped error instead, with the answer's status (err.status == 200; code INTERNAL when the body names none).
An InvalidResponseError means the answer was not a LexAPI answer in the
documented shape — for example a proxy's page, an outage page, or a body cut
off in transit. The client never retries a 2xx answer, and the call may
already have been charged, so retrying a paid call yourself can be charged
again.
Fields the client requires (a missing one raises InvalidResponseError with
Expected "<field>" in the response; it is missing, where missing means
absent, null, or an empty string where a string is required):
| Call | Required |
|---|---|
search, semantic_search, semantic_legislation_search, national.semantic_search, national.legislation_semantic_search |
results (a list) |
get_document, get_document_by_url, national.get_document, get_document_version, get_document_at_date |
document (an object) |
legislation_as_of |
document (a string), asOfResolved (a boolean), act, provenance (objects) |
The full list, including the list fields checked when present, is in the SDK contract §1.3.
InvalidResponseError does not quote the response body in its message. For a
body that is not JSON, the first 200 characters are on err.body_excerpt.
That excerpt (like err.body) is raw response content and may contain
document text; do not show it to a model or log it by default.
Retries
Retries are automatic (default: up to 3, exponential backoff from a 0.5 s base
with full jitter, honouring Retry-After) only when a retry cannot charge you twice. LexAPI
refunds a failed request only when its own app finishes the error response, so
the SDK retries:
- a 429 — any call (the rate limiter runs before any charge), except an
exhausted quota and a failed payment (
PAYMENT_PAST_DUE); - a 502/503/504 from the LexAPI app — GET calls (refunded in full);
- requests that never reached the app — connect errors, a stale keep-alive connection closed before any response, Cloudflare 521/522/523 — any call;
- anything else (proxy 502/504, Cloudflare 520/524 from any origin, a connection dropped
mid-response) only for free calls (
get_info, webhook reads).
Writes (POST/PUT/DELETE: webhook create/update/delete/test, citations.extract)
and, by default, the read-only POSTs are retried only on a 429 that is neither an
exhausted quota nor a failed payment, or when the request never reached the API
(connect failure, Cloudflare 521/522/523).
RetryConfig(retry_read_only_posts=True) additionally retries the
read-only POSTs (search, document reads, resolve, semantic search,
legislation_as_of) on an app-origin 502/503/504. A legacy-plan 429 that reports an exhausted quota
(code == "QUOTA_EXHAUSTED") is not retried (it can't succeed before resets_at), and neither is a 402.
A 2xx answer is never retried, whatever its body.
Every wait, server-directed ones included, is clamped to backoff_cap
(default 30 s): a cap below the server's requested wait shortens it.
backoff_base and backoff_cap must be finite and not negative. A
Retry-After, RateLimit-Reset or retryAfter hint that is not in a
documented form (delta-seconds; for Retry-After also an HTTP-date)
counts as absent, and the normal backoff applies. The full
rules are in the SDK contract.
from lexapi import LexAPI, RetryConfig
client = LexAPI(max_retries=5) # just the budget
client = LexAPI(
retry_config=RetryConfig( # full control
max_retries=2,
backoff_base=1.0,
backoff_cap=10.0,
)
)
client = LexAPI(retry_config=RetryConfig(retry_read_only_posts=True))
client = LexAPI(max_retries=0) # disable retries
Configuration
client = LexAPI(
api_key="lex_...", # or LEXAPI_API_KEY env var
base_url="https://lex-api.com/api/v1",
timeout=95.0, # per-attempt response timeout, seconds (or an httpx.Timeout)
connect_timeout=10.0,
user_agent_suffix="myapp/1.0", # appended to lexapi-python/<version>
)
# Per-call overrides share the connection pool:
client.with_options(timeout=30, max_retries=0).semantic_legislation_search(
"own funds", as_of="2019-06-01"
)
timeout is the longest the SDK waits for the next bytes of a response — the
response head, then each body chunk — on one attempt; it is not a deadline
for the whole call. The 95 s default sits above the API's 90 s deadline on
document reads, so that timeout comes back as a typed, refunded 504; the CDN
ends any wait at 100 s. A request can still run past the timeout and raise a
local RequestTimeoutError; values above ~100 s buy nothing on the public
endpoint. Both timeouts are numbers of seconds >= 0 (None means no limit);
a value longer than the timers support, inf included, is clamped to
2**31 - 1 ms (about 24.9 days), and nan or a negative value raises
ValueError when the client is created.
Development
pip install -e ".[dev]"
pytest
ruff check .
mypy
Metadata
Release files for lexapi-client 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| lexapi_client-0.5.0.tar.gz | 289.1 kB | Without provenance | Details for lexapi_client-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| lexapi_client-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for lexapi_client-0.5.0-py3-none-any.whl |
Total release size: 431.0 kB
Release files / lexapi_client-0.5.0.tar.gz
| Download URL | lexapi_client-0.5.0.tar.gz |
|---|---|
| Size | 289.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
59530d9d0f2cea280885b9b09fc59c1e017a8973ca13bba2649679846544999a
|
|
BLAKE2b-256 checksum How to use checksums |
027e5a16a024d4f04152477665cdf1d22b393c0f70016945001fc565e7ffba45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.6
|
Release files / lexapi_client-0.5.0-py3-none-any.whl
| Download URL | lexapi_client-0.5.0-py3-none-any.whl |
|---|---|
| Size | 141.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
01f2762f020767060c705490ab09bff5d48584d12f81fcb0257d0b7837a97031
|
|
BLAKE2b-256 checksum How to use checksums |
8e64dda442f42b5e3489a0453f5c065de3d2b45c32e72978e3d3a80c8cffdd82
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.6
|
Security for lexapi-client 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.