mirror of
https://github.com/mimblewimble/grin.git
synced 2025-01-21 11:31:08 +03:00
20 lines
1.1 KiB
Markdown
20 lines
1.1 KiB
Markdown
# Grin API Documentation
|
|
|
|
Used to query a node about various information on the blockchain, networks and peers. By default, the API will listen on `localhost:3413`. The API is started as the same time as the Grin node.
|
|
This endpoint requires, by default, [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). The username is `grin`.
|
|
|
|
## Node API v2
|
|
|
|
This API version uses jsonrpc for its requests. It is split up in a foreign API and an owner API. The documentation for these endpoints is automatically generated:
|
|
- [Owner API](https://docs.rs/grin_api/latest/grin_api/trait.OwnerRpc.html)
|
|
- [Foreign API](https://docs.rs/grin_api/latest/grin_api/trait.ForeignRpc.html)
|
|
|
|
Basic auth passwords can be found in `.api_secret`/`.foreign_api_secret` files respectively.
|
|
|
|
## Node API v1
|
|
|
|
**Note:** version 1 of the API will be deprecated in v4.0.0 and subsequently removed in v5.0.0. Users of this API are encouraged to upgrade to API v2.
|
|
|
|
This API uses REST for its requests. To learn about what specific calls can be made read the [node API v1 doc](node_api_v1.md).
|
|
|
|
Basic auth password can be found in `.api_secret`
|