getCounterpartyInfo

Returns information about the one or all connected and invited counterparties.

POST /cancelConnectionInvite

Payload

{
    "counterpartyId": 5 // Optional
}

200 OK

[
    {
        "clientId": 5,
        "clientType": "taker",
        "username": "Some User",
        "subaccount": true,
        "status": "connected"
    },
    ...
]

400 Bad request

{
  "error": 0
}

Request parameters

Field name	Type	Description
counterpartyId	Efx::ClientId	Optional. Id of counterparty to cancel or reject an invitation to connect.

Response description

Field name	Type	Description
clientId	Efx::ClientId	Id of connected client
clientType	string	Type of connected client: "maker", "taker" or "primeBroker" (that means master type)
username	string	Optional. Username of counterparty. Visible only if the counterparty sent or accepted a connection request.
subaccount	bool	Optional. True and present only if counterparty is a subaccount.
status	string	Connection status: "connected" - connection request has been accepted. "invite_sent" - you have sent an invitation to connect, but it has not been accepted yet. "invite_pending" - a counterparty sent you an invitation to connect.