Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-21 11:31:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
grin/doc/api/api.md
Simon B 0e0ec247e4 fix owner_api docs: wrong port number (#2442) 
* fix owner_api docs: wrong port number

* update ports since PR #2405. We now allow both floo and mainnet owner_apis to run in parallell on a single server, with ports 13420 or 3420

* correction since there is no --mainnet flag

* fixes the comment by @karkagis
2019-01-25 10:08:08 +00:00

1.7 KiB
Raw Blame History

Grin API Documentation

This document contains the documentation for the 3 Grin REST APIs. These endpoints can be grouped in two categories.

Node API

This endpoint is used to query a node about various information on the blockchain, networks and peers. By default, this REST API will listen on localhost:3413. This API is started as the same time as the Grin node. This endpoint requires, by default, Basic Authentication. The username is grin and the password can be found in the .api_secret file. To learn about what specific calls can be made read the node API doc.

Wallet APIs

Foreign Wallet API

The foreign API is an endpoint mainly designed to receiving grins through a network. This REST API can be started with the grin wallet listen command and by default will listen on localhost:3415. To learn about what specific calls can be made read the wallet foreign API doc.

Wallet Owner API

The wallet owner API is an endpoint to manage the user wallet: broadcast transaction, sign transaction, see the current balance... This REST API can be started with the grin wallet owner_api command and will listen on localhost:3420.

This endpoint must never be exposed to the outside world.

This endpoint requires, by default, Basic Authentication. The username is grin and the password can be found in the .api_secret file. To learn about what specific calls can be made read the wallet owner API doc.

Ports above 10000?

All ports should be below 10000 when running with default settings on mainnet. If your grin owner_api is using the 13420 port but is on mainnet, then you're using an outdated version of grin.