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()

Search across all frameworks (or a specific one).
Parameters
ParameterTypeDefaultDescription
$qstringrequiredSearch query
$frameworkstring|nullnullLimit to one framework slug
$resultTypestring|nullnullFilter by type: 'article', 'recital', 'requirement'
$pageint|nullnullPage number
$perPageint|nullnullItems per page
Returns Page<SearchResult>

Model

SearchResult

FieldTypeDescription
typestring'article', 'recital', or 'requirement'
frameworkSlugstringFramework the result belongs to
frameworkNamestringHuman-readable framework name
articleNumberint|nullFor article results
recitalNumberint|nullFor recital results
paragraphRefstring|nullSpecific paragraph reference
titlestring|nullResult heading, if any
requirementTypestring|nullFor requirement results
matchContextstringSnippet showing the match in context
urlstringDirect API URL to the full resource

Examples

Search across specific frameworks

Filter by result type

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.