Guide

Pagination

Les endpoints de liste paginent à l'aide d'un curseur opaque. Vous ne calculez jamais d'offsets : vous suivez nextCursor jusqu'à ce qu'il soit null. Les curseurs restent stables face aux écritures concurrentes, vous ne sautez donc jamais une ligne et n'en lisez jamais deux fois.

L'enveloppe de liste

Une réponse de liste enveloppe ses lignes dans items et renvoie un nextCursor. Lorsque nextCursor est null, vous avez atteint la fin.

json

{  "items": [    { "id": "01J8ME9AZ2K3W7X4V5T6R7Q8S9", "amountCents": "-4250" },    { "id": "01J8ME9B1Q2W3E4R5T6Y7V8H9J", "amountCents": "-1899" }  ],  "nextCursor": "eyJjIjoiMjAyNi0wNi0yMlQxODowNDoxMS4xMjM0NTZaIiwiaSI6IjAxSjhNRTlCMVEyVzNFNFI1VDZZN1Y4SDlKIn0"}

Tout parcourir

Passez le nextCursor précédent comme paramètre de query cursor pour récupérer la page suivante. Ajustez la taille de page avec limit (plafonnée côté serveur).

bash

curl -H "Authorization: Bearer vokse_sk_…" \  "https://api.vokse.ai/households/current/transactions?limit=100"

bash

# pass the previous nextCursorcurl -H "Authorization: Bearer vokse_sk_…" \  "https://api.vokse.ai/households/current/transactions?limit=100&cursor=eyJjIjoiMjAyNi0wNi0yMlQxODowNDoxMS4xMjM0NTZaIiwiaSI6IjAxSjhNRTlCMVEyVzNFNFI1VDZZN1Y4SDlKIn0"

Bon à savoir

Les curseurs sont opaques : ne les analysez pas et ne les construisez pas vous-même.
Un curseur reste valide même lorsque de nouvelles lignes sont insérées ; vous ne sauterez aucune ligne.
limit est une borne supérieure ; le serveur peut renvoyer moins de lignes que demandé.