Kiln API Docs (1.0.0)

This API provides reporting staking data on various protocols as well as network wide data, staking transaction crafting features and so on.

ACCESS

In order to use the Kiln API, you must first get an API token from your Kiln dashboard (applications section). If you don't have access to our dashboard, please get in touch at hello@kiln.fi.

Once you have your API token, you can set it as a bearer token in your HTTP request headers, and target the Kiln API endpoint with the current MAJOR version of the API as a prefix to routes:

curl "https://api.kiln.fi/v1/..." -H "Authorization: Bearer $KILN_API_TOKEN"

CHANGELOG

VERSIONING

Versions of the Kiln API use MAJOR.MINOR.PATCH where:

• MAJOR version is increased when there is major incompatible API changes, major versions will be communicated in advance to all customers with a smooth transition path that spans over a minimum period of 3 MINOR versions or ~3 months. Intended frequency: 1 year.
• MINOR version is increased for backward compatible API changes without notice, or communicated breaking changes with a 1 minor version notice and a smooth migration path. Minor versions will be communicated regularly to customers with the changelog. Intended frequency: 1 month.
• PATCH version is increased for backward compatible hot-fixes, patch versions will be communicated to affected customers.

BACKWARD COMPATIBILITY

Kiln considers the following changes to be backward compatible:

• Adding new API routes.
• Adding new optional request parameters to existing API methods.
• Adding new properties to existing API responses.
• Changing the order of properties in existing API responses.
• Adding new event types in existing enums.

Non-breaking changes may be introduced in our API and subject to modification before being officialy communicated and documented here. Your application should not depend on them until part of this specification. The preview Kiln API specifications with upcoming and experimental new features can be found here.