Syncs

Trigger a sync for a feed

Creates a sync job and queues it for execution. By default, transaction feeds use incremental (cursor-based) syncing. Pass startDate and endDate (YYYY-MM-DD) in the JSON body for a specific date range. Trade feeds always require a date range. Poll GET /feeds/:fid/jobs/:jid to monitor progress.

If a previous sync is already running (or its lock is stuck), this endpoint returns 409. Two recovery options: set forceCancelActive: true to cancel the active sync and start a fresh one, or DELETE /feeds/:fid/jobs/:jid to cancel the specific in-flight job. Pass resetCursors: true to clear cursors before fetching (full re-sync); pass skipDedup: true to bypass per-record dedup for backfills.

A feed that is not fully configured returns 400 with the missing piece named, and no job is created — forceCancelActive does not override this.

post/v1/feeds/{fid}/sync

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/feeds/{fid}/sync
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

fidstring required

Feed ID

Request body

startDatestring

Start date (YYYY-MM-DD) for date-range syncs (transactions, trades).

endDatestring

End date (YYYY-MM-DD) for date-range syncs (transactions, trades).

forceCancelActiveboolean

When true, cancel any currently-running sync on this feed before starting the new one. Use this for user-initiated retries when the previous sync is stuck. Defaults to false.

resetCursorsboolean

When true, clear all per-bank cursors, tier-1/tier-2 dedup state, and the date-based watermark before fetching. Use for backfills or recovery when the incremental cursor has gone stale. Defaults to false (normal incremental sync).

skipDedupboolean

When true, bypass the per-record dedup guard for this run. Use for backfills where upstream IDs are known-stable but downstream dedup has drifted. Defaults to false.

Response

Sync job created

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.