Skip to main content
GET
/
atlas
/
settlements
List settlements
curl --request GET \
  --url https://api.anchorage-staging.com/v2/atlas/settlements \
  --header 'Api-Access-Key: <api-key>'
{
  "data": [
    {
      "acceptorSide": {
        "participantId": "<string>",
        "authorized": true,
        "feesFunded": true,
        "funded": true,
        "gasStationEnabled": true,
        "walletAmounts": [
          {
            "assetType": "BTC",
            "quantity": "10.45234733",
            "walletId": "<string>"
          }
        ]
      },
      "clientReferenceId": "<string>",
      "pendingAcceptorReview": true,
      "proposerSide": {
        "participantId": "<string>",
        "authorized": true,
        "feesFunded": true,
        "funded": true,
        "gasStationEnabled": true,
        "walletAmounts": [
          {
            "assetType": "BTC",
            "quantity": "10.45234733",
            "walletId": "<string>"
          }
        ]
      },
      "settlementId": "<string>"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Query Parameters

afterId
string

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

limit
integer<int64>
default:30

Maximum number of results to return per query

Required range: 1 <= x <= 100

Response

settlements

data
object[]
required
page
Page · object
required

Pagination info