Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-20 19:11:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
grin/doc/api/api.md
jaspervdm 7385e8ce7f
Update API docs (#3277)
2020-03-28 12:53:20 +01:00

1.1 KiB
Raw Permalink Blame History

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. 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:

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.

Basic auth password can be found in .api_secret