Using the APIs

This page outlines some specifics on how best to communicate with the API.

  • Katapult provides a few APIs which are all accessed through the api.katapult.io host.
  • All APIs will accept and return JSON over HTTPS only.
  • There are rate limits in place to prevent abuse.

Documentation

Katapult's API documentation is generated automatically and is available to view at the following URLs.

  • Core API - this is the main API that provides access to the core functionality in Katapult unlesss provided by another API.
  • Public API - this API provides access to some useful endpoints that can be used anonymously (for example to find out pricing information).

These documentation sites will provide further information on exactly how to send and receive data from the APIs.