List business rules

GET

https://your-protect-instance.example.com/api/rest/v2/businessrules

GET

/api/rest/v2/businessrules

curl https://your-protect-instance.example.com/api/rest/v2/businessrules \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "id": "string",
      "tenantId": "string",
      "currency": "string",
      "walletId": "string",
      "ruleKey": "string",
      "ruleValue": "string",
      "ruleGroup": "string",
      "ruleDescription": "string",
      "ruleValidation": "string",
      "addressId": "string",
      "currencyInfo": {
        "name": "string",
        "symbol": "string",
        "coinTypeIndex": "string",
        "blockchain": "string",
        "isToken": true,
        "isERC20": true,
        "decimals": "string",
        "contractAddress": "string",
        "hasStaking": true,
        "isUTXOBased": true,
        "isAccountBased": true,
        "isFiat": true,
        "isFA12": true,
        "isFA20": true,
        "isNFT": true,
        "enabled": true,
        "id": "string",
        "displayName": "string",
        "type": "string",
        "wlcaId": "string",
        "network": "string",
        "tokenID": "string",
        "logo": "string"
      },
      "entityType": "string",
      "entityID": "string"
    }
  ],
  "cursor": {
    "currentPage": "string",
    "hasPrevious": true,
    "hasNext": true
  }
}

This endpoint returns a list of business rules. Required role: Admin or AdminReadOnly.

Authentication

AuthorizationBearer

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

Query parameters

idslist of stringsOptional

ruleKeyslist of stringsOptional

ruleGroupslist of stringsOptional

walletIdslist of stringsOptional

Deprecated - Use EntityType and EntityID instead

currencyIdslist of stringsOptional

Filter on currency ids

addressIdslist of stringsOptional

Deprecated - Use EntityType and EntityID instead

levelstringOptional

Deprecated - Use EntityType instead

one of '', 'global', 'currency', 'address', 'wallet'

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

entityTypestringOptional

Filters rules by what they apply to. This can be one of global, currency, wallet, address, exchange, exchange_account, tn_participant.

entityIDslist of stringsOptional

Filters rules by the identifier of the affected entity. For wallets, addresses, and currencies this is their ID. For exchanges this is the exchange label. Leave this field blank for global rules.

Response

A successful response.

resultlist 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