Walletguide
DevelopersAPIReferencetransactions

Search

Filter, sort, and paginate transactions. Filters compile to SQL where possible (fast path); a usingDate filter adds a JS pass for the proportional partial…

POST
/wallets/{walletId}/transactions/search

Authorization

bearerAuth
headerAuthorization<token>

A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.

Path Parameters

walletId*string

Row uuid

Formatuuid

Request Body

application/json
  1. body
limit?integer

Number of transactions to return (1-500, default 100).

Range1 <= value <= 500
Default100
offset?integer

Number of transactions to skip (default 0).

Range0 <= value
Default0
sortBy?string

Column to sort by. amountValue sorts by the signed amount (money out is negative); amountMagnitude sorts by the absolute amount, so asc puts the smallest payments in either direction first.

Default"date"
Value in"date""amountValue""amountMagnitude""fromTo"
sortDirection?string

Sort direction.

Default"desc"
Value in"asc""desc"
filters?array<||||||||||||||||>

Filter objects. Each filter is active by its presence.

Default[]

Response Body

Paginated search results

application/json
  1. response
items*array<>
totalCount*number

Total transactions matching all filters.

balanceByDate?

End-of-day running balance per visible date, in the asset's own currency. Populated only when the page rows share one asset and sortBy=date.

Example Request
curl -X POST 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08/transactions/search' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",      "firestoreId": "string",      "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",      "date": "string",      "secondaryDate": "string",      "fromTo": "string",      "description": "string",      "amountValue": "string",      "amountCurrency": "EUR",      "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",      "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",      "merchantAutoAssigned": true,      "merchantCheckedGoogleMaps": true,      "merchantCheckedSearchApiGoogleWebSearch": true,      "excludeFromMerchantAutoAssignment": true,      "usingDateRule": "transactionDate",      "usingStartDate": "string",      "usingEndDate": "string",      "notes": "string",      "parentTransactionId": "f8033cf6-befa-47f4-a48a-b915b8c72a71",      "parent": true,      "source": "string",      "assignedUserId": "string",      "transferCounterType": "transaction",      "transferCounterId": "bfd53a44-3603-4023-978c-daf5f740c5fd",      "gocardlessTransactionId": "string",      "gocardlessInternalTransactionId": "string",      "finApiTransactionId": "string",      "plaidTransactionId": "string",      "klarnaTransactionId": "string",      "tagIds": [        "9c99701b-f191-4642-8bc0-e04053f29131"      ],      "pending": true,      "reviewed": true,      "createdTime": "2019-08-24T14:15:22Z",      "createdUserId": "string",      "lastUpdatedTime": "2019-08-24T14:15:22Z",      "lastUpdatedUserId": "string",      "partialAmount": 0,      "categoryName": "string",      "categoryEmoji": "string",      "categorySystemKey": "string",      "categoryGroupName": "string",      "categoryGroupFullName": "string",      "categoryFullName": "string",      "merchantName": "string",      "merchantLogoUrl": "string",      "merchantDomains": [        "string"      ],      "assetName": "string",      "assetType": "string",      "assetDefaultCurrency": "string",      "assetBankConnection": {        "property1": null,        "property2": null      },      "isTransfer": true,      "counterTransactionId": "string",      "splitParentId": "string",      "hasSplits": true,      "splitChildCount": 0,      "splitChildTotal": 0,      "tags": [        {          "id": "string",          "name": "string"        }      ],      "commentCount": 0,      "fileCount": 0,      "comments": [        {          "property1": null,          "property2": null        }      ],      "files": [        {          "property1": null,          "property2": null        }      ],      "childTransactions": [        {          "property1": null,          "property2": null        }      ]    }  ],  "totalCount": 0,  "balanceByDate": {    "property1": {      "value": 0,      "currency": "string"    },    "property2": {      "value": 0,      "currency": "string"    }  }}