Skip to main content
An adapter retrieves points data from a project’s endpoint and returns it in a format the aggregator can use. Once the adapter proves reliable, the next stage is opening a market.

Add your points program

Submit an adapter PR for the Checkpoint Aggregator and include your project details in the PR description. The repository’s getting started guide covers adapter implementation and contribution requirements.

Adapter repository

View the contribution guide.

Contact contributors

Reach Checkpoint core contributors.

Adapter requirements

The adapter must:
  • Return accurate points balances for the correct account and program.
  • Distinguish seasons or balances with different allocation or redemption rules.
  • Report endpoint errors and unavailable data without returning them as valid balances.
  • Remain compatible with changes to the project’s points system.
The underlying endpoint must remain reliable so Checkpoint can consistently verify points balances.
Frequent adapter failures can result in markets being paused until reliable points verification is restored.
See the Points API and Oracle System for how adapter data is used.

From aggregator to market

Adding an adapter to the aggregator does not automatically open a market. Once the adapter proves reliable, Checkpoint contributors can help to configure and open a market. Project participation is optional. An adapter does not itself establish eligibility to receive fees; the requirements are covered under Project Commitments.

Choose an integration type

Compare settlement and redemption models.

Points program considerations

Predictable points issuance helps market participants assess dilution and compare balances. A defined supply cap or issuance schedule, clear season boundaries and visibility into total points issued can support this. Where points determine a future allocation or redemption benefit, clarity on how additional issuance and program changes affect eligibility is also useful.