Skip to main content
GET
/
v1
/
addresses
/
{addressId}
/
settlement-rules
List address settlement rules
curl --request GET \
  --url https://api.xentfi.com/v1/addresses/{addressId}/settlement-rules \
  --header 'apiKey: <api-key>' \
  --header 'orgId: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "walletId": "<string>",
      "slippageTolerance": "<string>",
      "isActive": true,
      "source": {
        "blockchainId": "<string>",
        "assetIds": [
          "<string>"
        ],
        "minAmount": "<string>",
        "maxAmount": "<string>"
      },
      "destination": {
        "blockchainId": "<string>",
        "assetId": "<string>",
        "address": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "hasMore": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.xentfi.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

apiKey
string
header
required
orgId
string
header
required

Path Parameters

addressId
string
required

Query Parameters

isActive
boolean
from
string
to
string
offset
integer
default:0
limit
integer
default:10
order
enum<string>
Available options:
ASC,
DESC

Response

List of settlement rules

data
object[]
total
integer
hasMore
boolean