Skip to main content

Overview

The search endpoint lets you query across all frameworks simultaneously. Results include articles, recitals, and requirements that match your query. Use client.search().query() to search.

Methods

query(String q)

Search across all frameworks with default pagination.
Returns Page<SearchResult>

query(String q, String framework, String resultType, int page, int perPage)

Search with optional framework scope, result type filter, and custom pagination.
Parameters
ParameterTypeDefaultDescription
qStringrequiredSearch query
frameworkStringnullLimit to one framework slug
resultTypeStringnullFilter by type: "article", "recital", "requirement"
pageint1Page number
perPageint20Items per page
Returns Page<SearchResult>

iter(String q)

Lazily iterate all search results for a query.
Returns Iterable<SearchResult>

iter(String q, String framework, String resultType)

Lazily iterate with optional framework and result-type filters.
Returns Iterable<SearchResult>

Model

SearchResult

FieldTypeDescription
type()String"article", "recital", or "requirement"
frameworkSlug()StringFramework the result belongs to
frameworkName()StringHuman-readable framework name
articleNumber()StringFor article results
recitalNumber()StringFor recital results
paragraphRef()StringSpecific paragraph reference
title()StringResult heading, if any
requirementType()StringFor requirement results
matchContext()StringSnippet showing the match in context
url()StringDirect API URL to the full resource

Examples

Search within a specific framework

Filter by result type

Cross-framework comparison

Use the framework parameter to narrow results when you know which regulation you’re working with. Cross-framework search (without a filter) is great for discovering related obligations across different laws.