Skip to navigation
Taurus-PROTECT APIsTaurus Network

List shared addresses

This endpoint returns a list of addresses that you shared or that are shared to you via Taurus-NETWORK. You can filter the results by specifying the owner or the target of the shared addresses.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

participantIDstringOptional
Get all the shared addresses where the participantID is either the owner or the target of the shared address.
ownerParticipantIDstringOptional

Filter shared addresses by specifying who is the owner of the shared addresses (your participant or the counterparty)

targetParticipantIDstringOptional

Filter shared addresses by specifying who is the target of the shared addresses (your participant or the counterparty)

blockchainstringOptional
Filter shared addresses by specifying the blockchain of the shared addresses
networkstringOptional
Filter shared addresses by specifying the network of the shared addresses. It must be used in combination with the blockchain filter.
idslist of stringsOptional
Filter shared addresses by specifying the shared address IDs
sortOrderstringOptional
Set this parameter to ASC to get the id sorted in ASC order or DESC to get them in descending order. By default, the order is DESC.
cursor.currentPagestringOptional

Base64-encoded string representing the current window of data

cursor.pageRequeststringOptional

The page to request, w.r.t the current page. Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSizestringOptionalformat: "uint64"
The size of the page requested. The handling service should impose a hard limit on this
statuseslist of stringsOptional

Filter shared addresses by specifying a list of statuses. Accepted status values: 'new', 'pending', 'rejected', 'accepted', 'unshared'

Response

A successful response.
sharedAddresseslist of objectsOptional
cursorobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error