Parties list

GET 
/parties

Get a list of parties. This endpoint may not be exposed by mainnet nodes.

Responses

200

A successful response.

application/json

Schema

Schema

parties object[]
Array [
alias string
Alias given to the party.
id string
Unique ID for the party, typically represented by a public key.
metadata object[]
Metadata to associate to a party, in a key/value format where the key describes the type of metadata in the value field.
Array [
key string
Key of the metadata.
value string
Value of the metadata.
]
]

Example (from schema)

{
  "parties": [
    {
      "alias": "string",
      "id": "string",
      "metadata": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...