Skip to main content
GET
/
counterparties
Get Counterparties
curl --request GET \
  --url https://api.copper.co/platform/counterparties
{
  "counterparties": [
    {
      "backgroundImageId": "<string>",
      "counterpartyDescription": "<string>",
      "counterpartyId": "<string>",
      "counterpartyName": "<string>",
      "counterpartyType": "standard",
      "extra": {
        "exchangeId": "<string>"
      },
      "imageId": "<string>",
      "networkTag": "<string>",
      "priority": "<string>",
      "tags": [
        "featured"
      ]
    }
  ]
}
To initiate a settlement you need to know the counterpartyId. You can find it using this API.

Query Parameters

offset
string
limit
string
default:1000
isConnected
boolean
counterpartyIds
string[]
counterpartyTypes
enum<string>[]
includeConnections
boolean
default:true
includeCounterpartyDetails
boolean
default:true

Response

counterparties
object[]
required