> For the complete documentation index, see [llms.txt](https://savefee.gitbook.io/savefee/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://savefee.gitbook.io/savefee/api-reference.md).

# API Reference

These are the endpoints available to a partner integration.

| Method | Path                            | Auth     | Purpose                                                                |
| ------ | ------------------------------- | -------- | ---------------------------------------------------------------------- |
| `GET`  | `/v1/balance`                   | key      | Read your available balance and deposit address.                       |
| `POST` | `/v1/orders`                    | key      | Buy energy.                                                            |
| `GET`  | `/v1/orders/{orderId}`          | key      | Read one order.                                                        |
| `POST` | `/v1/broadcasts`                | optional | Broadcast a signed transaction.                                        |
| `GET`  | `/v1/broadcasts/{broadcastId}`  | key      | Read one broadcast.                                                    |
| `GET`  | `/v1/public/pricing`            | none     | The live energy price table.                                           |
| `GET`  | `/v1/public/system`             | none     | Public service information.                                            |
| `GET`  | `/v1/public/onboarding-deposit` | none     | The address and minimum for your first deposit, before you have a key. |

Start with **Overview** for the conventions that apply to all of them: authentication, the error envelope, idempotency, and limits.

{% hint style="info" %}
Store the `orderId` returned by `POST /v1/orders`. It is how you read an order back with `GET /v1/orders/{orderId}`. The same goes for the `broadcastId` returned by `POST /v1/broadcasts`.
{% endhint %}