Swagger UI for Ergo Node

Advanced Operations

The Swagger UI allows you to perform advanced operations that might not be available through graphical wallet interfaces, such as:

• Creating non-standard transactions with registers and context variables.
• Issuing tokens through transactions.
• Creating transactions that use specific boxes as inputs.

Accessing the API

Once the node is running, the API endpoints are typically accessible at 127.0.0.1:9053 (the default API port, distinct from the P2P port 9030).

To explore the API methods without setting up your own node, you can use the Swagger UI of public nodes, such as:

To access protected API routes (like wallet operations), you must provide your API key (the secret phrase/password you set in the node configuration) in the api_key HTTP header of your requests. Alternatively, you can authorize your session directly within the Swagger UI interface by clicking the Authorize button and entering your API key there.

Authorization Process via Swagger UI

1. 1Navigate to the Swagger UI page (e.g., 127.0.0.1:9053/swagger).
2. 2Click the green "Authorize" button located near the top right.
3. 3A dialog box will appear. Enter your plain text API key (the secret phrase you configured) into the Value field.
4. 4Click "Authorize" within the dialog, then "Close".

Your browser session is now authorized to access protected endpoints.

For example, navigate to the wallet/walletAddresses endpoint, click "Try it out", and then "Execute". If authorized correctly, you should see the list of addresses managed by your node's wallet.

Main Methods

Here are some of the main methods you can use:

Example: Deriving Addresses

To derive a specific address, navigate to the /wallet/deriveKey endpoint, click "Try it out", and enter the desired derivation path in the derivationPath field. For example, to derive the first standard address: