/{chain}/parties/search

Returns the Canton parties that match a search term. Use it to find a party ID before querying other endpoints.

The term is matched against registered display names, Featured App names, and party IDs. A party ID fragment must be at least three characters. Parties without a registered name are returned with a null display name and the organization type unknown.

Results are not paginated; the API returns the best matches, up to pageSize. A missing or empty q returns an empty list. To browse all known parties, use GET /{chain}/directory.

Path Params
string
required
Defaults to canton

Canton chain name. Use a name returned by GET /chains.

Query Params
string
length between 0 and 256

Display name, Featured App name, or party ID fragment to search for. Maximum 256 characters.

int32
1 to 100
Defaults to 20

Maximum number of matches returned. Default is 20; maximum is 100.

Headers
string
required
Defaults to demokey

API Key for Canton API. To generate an API Key, visit https://app.noves.fi

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json