Saltar al contenido

Referencia de API

Paginación

Los endpoints que listan (/v1/links, /v1/accounts y /v1/accounts/{id}/movements) usan paginación por cursor. A diferencia de la paginación por número de página, no repite ni salta elementos si llegan datos nuevos mientras recorres la lista.

Parámetros

limitinteger
Cantidad de elementos por página, entre 1 y 100. Por defecto 50.
starting_afterstring
Cursor: el id del último elemento de la página anterior. Devuelve los elementos que vienen después.

La respuesta es un objeto list. Si has_more es true, pide la página siguiente con starting_after igual al id del último elemento de data.

curl "https://api.banky.cl/v1/accounts/acc_3f9a1c0e5b7d2468/movements?limit=100&starting_after=mov_c07f3e9a15b2d846" \
  -H "Authorization: Bearer $BANKY_SECRET_KEY"

Recorrer una lista completa

async function todosLosMovimientos(cuentaId, desde) {
  const movimientos = [];
  let cursor = null;
  do {
    const params = new URLSearchParams({ since: desde, limit: "100" });
    if (cursor) params.set("starting_after", cursor);
    const respuesta = await fetch(`https://api.banky.cl/v1/accounts/${cuentaId}/movements?${params}`, {
      headers: { Authorization: `Bearer ${process.env.BANKY_SECRET_KEY}` },
    });
    if (!respuesta.ok) throw new Error(`Error ${respuesta.status}`);
    const pagina = await respuesta.json();
    movimientos.push(...pagina.data);
    cursor = pagina.has_more ? pagina.data.at(-1).id : null;
  } while (cursor);
  return movimientos;
}

Orden

  • Links y cuentas: del más reciente al más antiguo según su fecha de creación.
  • Movimientos: por fecha contable, del más nuevo al más antiguo.
  • El cursor debe ser un id del mismo recurso y de la misma lista: un mov_… para movimientos de esa cuenta, un link_… para links. Si no lo es, la API responde invalid_cursor.
  • Los filtros (since, until, link_id) deben ser los mismos en todas las páginas.