Prefetch Cursors

POST {api-url}/prefetchCursors?ns={community}

Pre-calculates and returns a map of all cursors needed to navigate through a transaction result set page by page. Useful for retrieving a lot of data in parallel or in batches.

Note

Ensure sort and filters are consistent between /prefetchCursors and /viewDisbursementTransactions.

Request

Parameters

Field	Type	Requirement	Description
UIDx	Integer	Required	The unique internal identifier for this disbursement.
PageSize	Integer	Optional	The number of transactions to return per page. Max 1000, defaults to 1000.
SortField	String	Optional	The field to sort by (e.g., Amount).
SortOrder	String	Optional	The sort order (asc or desc).
Filters	Array	Optional	An array of filter objects. See Sort and Filter Rules.

Example Body

{
  "UIDx": 637,
  "PageSize": 1000,
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "<",
      "Value": 5000
    }
  ]
}

Response

Parameters

Field	Type	Description
Total	Integer	The total number of pages/cursors returned.
Cursors	Object	A map where the key is the page number and the value is the cursor string. Page “1” has an empty string.

Example Body

{
    "Total": 10,
    "Cursors": {
        "1": "",
        "10": "c09RQ3RFe2E0NQNRU105AGFvYWssbwohd04Ce0ha...",
        "2": "a1dJW2xrY3ksLRtJS0UhGHl3ZXNlUjwpZmhAX3cb4...",
        "3": "b1NNX2hvZ30oKR9NT0ElHH1zYXdhVjgtYlZEW3MfD...",
        "4": "b1NNX2hvZ30oKR9NT0ElHH1zYXdhVjgtYlZEW3MfD...",
        "5": "b1NNX2hvZ30oKR9NT0ElHH1zYXdhVjgtYlZEW3MfD...",
        "6": "c09RQ3RFe2E0NQNRU105AGFvYWsmViAgd04Ce0h4a...",
        "7": "c09RQ3RFe2E0NQNRU105AGFvYWtlbQogd04Ce0h4a...",
        "8": "c09RQ3RFe2E0NQNRU105AGFvYWtlbQogd04Ce0h4a...",
        "9": "c09RQ3RFe2E0NQNRU105AGFvYWtsaBYgd04Ce0h4a..."
    }
}

cURL

curl -X POST '{api-url}/prefetchCursors?ns={community}' \
-H 'Authorization: bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"UIDx":637,"PageSize":1000,"SortField":"Amount","SortOrder":"asc","Filters":[{"Field":"Amount","Operator":"<","Value":5000}]}'

C#

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var client = new HttpClient();
        var request = new HttpRequestMessage(HttpMethod.Post, "{api-url}/prefetchCursors?ns={community}");
        request.Headers.Add("Authorization", "bearer YOUR_TOKEN");

        var jsonPayload = @"{
  ""UIDx"": 637,
  ""PageSize"": 1000,
  ""SortField"": ""Amount"",
  ""SortOrder"": ""asc"",
  ""Filters"": [
    {
      ""Field"": ""Amount"",
      ""Operator"": ""<"",
      ""Value"": 5000
    }
  ]
}";
        request.Content = new StringContent(jsonPayload, Encoding.UTF8, "application/json");

        var response = await client.SendAsync(request);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Go

package main

import (
  "fmt"
  "io/ioutil"
  "net/http"
  "strings"
)

func main() {
  url := "{api-url}/prefetchCursors?ns={community}"
  payload := strings.NewReader(`{"UIDx":637,"PageSize":1000,"SortField":"Amount","SortOrder":"asc","Filters":[{"Field":"Amount","Operator":"<","Value":5000}]}`)

  req, _ := http.NewRequest("POST", url, payload)
  req.Header.Add("Authorization", "bearer YOUR_TOKEN")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()

  body, _ := ioutil.ReadAll(res.Body)
  fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ApiRequest {
    public static void main(String[] args) throws Exception {
        var payload = """
                {
  "UIDx": 637,
  "PageSize": 1000,
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "<",
      "Value": 5000
    }
  ]
}
                """;

        var request = HttpRequest.newBuilder()
                .uri(URI.create("{api-url}/prefetchCursors?ns={community}"))
                .header("Authorization", "bearer YOUR_TOKEN")
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(payload))
                .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Node.js

// Requires Node.js v18+
(async () => {
    const url = '{api-url}/prefetchCursors?ns={community}';
    const payload = {
    "UIDx": 637,
    "PageSize": 1000,
    "SortField": "Amount",
    "SortOrder": "asc",
    "Filters": [
        {
            "Field": "Amount",
            "Operator": "<",
            "Value": 5000
        }
    ]
};

    try {
        const response = await fetch(url, {
            method: 'POST',
            headers: {
                'Authorization': 'bearer YOUR_TOKEN',
                'Content-Type': 'application/json'
            },
            body: JSON.stringify(payload)
        });
        const data = await response.json();
        console.log(data);
    } catch (error) {
        console.error('Error:', error);
    }
})();

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '{api-url}/prefetchCursors?ns={community}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
  "UIDx": 637,
  "PageSize": 1000,
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "<",
      "Value": 5000
    }
  ]
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: bearer YOUR_TOKEN',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);
curl_close($curl);
echo $response;

Python

import requests
import json

url = "{api-url}/prefetchCursors?ns={community}"
payload = {
  "UIDx": 637,
  "PageSize": 1000,
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "<",
      "Value": 5000
    }
  ]
}

headers = {
    "Authorization": "bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

Ruby

require 'uri'
require 'net/http'
require 'json'

url = URI("{api-url}/prefetchCursors?ns={community}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'bearer YOUR_TOKEN'
request["Content-Type"] = 'application/json'

request.body = JSON.dump({
  "UIDx": 637,
  "PageSize": 1000,
  "SortField": "Amount",
  "SortOrder": "asc",
  "Filters": [
    {
      "Field": "Amount",
      "Operator": "<",
      "Value": 5000
    }
  ]
})

response = http.request(request)
puts response.read_body