Skip to main content
GET
The changes feed: every record that changed, in the order the changes were published. Follow it with a stored cursor to keep a copy of registers current.
  • Subscribe: call without since or cursor to start from now. You get an empty page and a next_cursor.
  • Start from a time: since (RFC 3339, with Z or an offset) is inclusive and cannot be earlier than feed_start. Use it on the first call only.
  • Continue: send cursor with the same jurisdiction as the first call. next_cursor is never null; store it after every page.
  • Done for now: has_more: false means everything published before complete_through has been delivered. Poll again later, at most every 15 minutes.
  • Items carry the record as it is when you read the page, as a summary, or as a full record with include=full (limit at most 25).
  • Registers that are reloading are skipped and listed in unavailable_jurisdictions. If every register named in jurisdiction is reloading, the call gets 503 jurisdiction-unavailable.
Syncing shows the complete loop, the initial load and recovery.

Authorizations

Authorization
string
header
required

Your API key: Authorization: Bearer pk_live_... (or pk_test_...).

Query Parameters

since
string<date-time>

First call only: start from this time (RFC 3339 with Z or an offset, inclusive; not before feed_start). Without since and cursor the feed starts now.

jurisdiction
string[]

Registers to follow. Repeat the parameter or separate values with commas (OR), up to 20. Send the same set with every cursor.

limit
integer
default:100

Items per page, 1 to 100 (default 100; at most 25 with include=full).

Required range: 1 <= x <= 100
include
string[]

full: full trademark objects instead of summaries (limit at most 25).

Allowed value: "full"
cursor
string

next_cursor of the previous page; store it after every page.

Maximum string length: 6000

Response

Successful Response

object
string
required
Allowed value: "list"
data
Change · object[]
required
has_more
boolean
required
next_cursor
string
required
unavailable_jurisdictions
string[]
required
feed_start
string | null
required
complete_through
string
required