# Braiins Contracts API

**Canonical:** https://apis.io/apis/braiins-academy/braiins-academy-contracts-api/  
**Provider:** Braiins — https://apis.io/providers/braiins-academy/  
**Base URL:** http://miner/api/v1  
**Documentation:** https://academy.braiins.com/braiins-os/papi-about.md

Braiins Contracts API is one of 19 APIs that [Braiins](https://apis.io/providers/braiins-academy/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Contracts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a changelog, a getting-started guide, and pricing.

Quote, schedule, manage, and inspect caller-owned fixed-duration contracts.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| GET | `/contract` | List caller-owned contracts |
| POST | `/contract` | Schedule a new caller-owned contract |
| POST | `/contract/quote` | Quote and validate a contract creation request |
| GET | `/contract/pricing` | List current contract pricing |
| GET | `/contract/cancel-fee` | List current contract cancellation fees |
| POST | `/contract/availability` | Check whether requested contract hashrate is available |
| GET | `/contract/active` | List caller-owned pending, running, or paused contracts |
| GET | `/contract/{contract_id}/detail` | Get a caller-owned contract |
| GET | `/contract/settings` | Get effective contract policy settings |
| POST | `/contract/{contract_id}:cancel` | Request cancellation for a pending caller-owned contract |
| POST | `/contract/{contract_id}:terminate` | Terminate an active caller-owned contract |
| GET | `/contract/activity` | List contract activity for the caller |
| GET | `/contract/{contract_id}/reservation` | List reservation history for a caller-owned contract |
| GET | `/contract/{contract_id}/settlement` | List settlement history for a caller-owned contract |
| GET | `/contract/{contract_id}/speed` | Get contract hashrate history time series |
| GET | `/contract/{contract_id}/delivery` | Get contract delivery history time series |

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/braiins-academy/refs/heads/main/openapi/braiins-academy-contracts-api-openapi.yml
- **Protobuf** — https://raw.githubusercontent.com/api-evangelist/braiins-academy/refs/heads/main/grpc/braiins-academy-bos-miner.proto
- **Documentation** — https://academy.braiins.com/braiins-os/papi-about.md
- **APIReference** — https://developer.braiins-os.com/latest/openapi.html
- **SourceCode** — https://github.com/braiins/bos-plus-api
- **Examples** — https://github.com/braiins/bos-plus-api-demos
- **ChangeLog** — https://academy.braiins.com/braiins-os/papi-changelog.md
- **Documentation** — https://academy.braiins.com/braiins-hashpower/api.md
- **APIReference** — https://hashpower.braiins.com/api
- **GettingStarted** — https://academy.braiins.com/braiins-hashpower/quick-start.md
- **Pricing** — https://academy.braiins.com/braiins-hashpower/fees.md
- **TermsOfService** — https://hashpower.braiins.com/terms-and-conditions.html

## Other Braiins APIs (12)

- [Braiins Pool API](https://apis.io/apis/braiins-academy/braiins-pool-api/)
- [Braiins Accounts API](https://apis.io/apis/braiins-academy/braiins-academy-accounts-api/)
- [Braiins Actions API](https://apis.io/apis/braiins-academy/braiins-academy-actions-api/)
- [Braiins Advanced Settings API](https://apis.io/apis/braiins-academy/braiins-academy-advanced-settings-api/)
- [Braiins Authentication API](https://apis.io/apis/braiins-academy/braiins-academy-authentication-api/)
- [Braiins Bid orders API](https://apis.io/apis/braiins-academy/braiins-academy-bid-orders-api/)
- [Braiins Configuration API](https://apis.io/apis/braiins-academy/braiins-academy-configuration-api/)
- [Braiins Cooling API](https://apis.io/apis/braiins-academy/braiins-academy-cooling-api/)
- [Braiins Documentation API](https://apis.io/apis/braiins-academy/braiins-academy-documentation-api/)
- [Braiins License API](https://apis.io/apis/braiins-academy/braiins-academy-license-api/)
- [Braiins Market configuration API](https://apis.io/apis/braiins-academy/braiins-academy-market-configuration-api/)
- [Braiins Market data API](https://apis.io/apis/braiins-academy/braiins-academy-market-data-api/)

## Tags

Contracts

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/braiins-academy/braiins-academy-contracts-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/braiins-academy/.