Regbase API

Searching

Find entities with natural-language text and field qualifiers.

Send a GET request to /v1/search. Put the full query in the q parameter:

curl --get "https://api.regbase.com/v1/search" \
  --header "Authorization: Bearer $REGBASE_API_KEY" \
  --data-urlencode 'q=jurisdiction:US.CA "clean energy"'

The response contains matching entities in data.

Build a query

A search query is a GitHub-flavoured Filter String. It can contain:

  • Free text, such as clean energy
  • A quoted phrase, such as "clean energy"
  • Field qualifiers, such as jurisdiction:US.CA
  • Excluded text, such as -transportation

Combine them in one string:

type:legislation jurisdiction:US.CA "clean energy" -transportation

Qualifiers filter the data before ranking. Regbase ranks the remaining free text with full-text and semantic search.

Qualifier-only searches

You can omit free text:

curl --get "https://api.regbase.com/v1/search" \
  --header "Authorization: Bearer $REGBASE_API_KEY" \
  --data-urlencode 'q=jurisdiction:US.CA status:Passed'

A qualifier-only search returns up to 100 matching entities without relevance ranking.

Search results are not paginated. Use the list endpoint when you need every entity that matches a filter.

On this page