How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Algorand private API

The private API from Algorand — 7 operation(s) for private.

Algorand private API is one of 15 APIs that Algorand publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Private. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 7 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 0.0.1.

Requests are made against 2 base URLs: http://localhost/, https://localhost/.

12 operations 7 paths 4 schemas 2 DELETE4 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
https://mainnet-api.4160.nodely.dev
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Algorand private API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Algo-API-Token (api_key). By default, every request must be authenticated.

  • api_key — Generated header parameter. This token can be generated using the Goal command line tool. Example value ='b7e384d0317b8050ce45900a94a1931e28540e1f69b2d242b4246…

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 2 DELETE, 4 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

private 12
GET
/debug/settings/config
Gets the merged config file.
GetConfig → 200default
GET
/debug/settings/pprof
Retrieves the current settings for blocking and mutex profiles
GetDebugSettingsProf → 200
PUT
/debug/settings/pprof
Enables blocking and mutex profiles, and returns the old settings
PutDebugSettingsProf → 200
DELETE
/v2/catchup/{catchpoint}
Aborts a catchpoint catchup.
AbortCatchup 1 param → 200400401500default
POST
/v2/catchup/{catchpoint}
Starts a catchpoint catchup.
StartCatchup 2 params → 200201400401408500default
GET
/v2/participation
Return a list of participation keys
GetParticipationKeys → 200400401404500default
POST
/v2/participation
Add a participation key to the node
AddParticipationKey body → 200400401404500503default
POST
/v2/participation/generate/{address}
Generate and install participation keys to the node.
GenerateParticipationKeys 4 params → 200400401500503default
DELETE
/v2/participation/{participation-id}
Delete a given participation key by ID
DeleteParticipationKeyByID 1 param → 200400401404500default
GET
/v2/participation/{participation-id}
Get participation key info given a participation ID
GetParticipationKeyByID 1 param → 200400401404500default
POST
/v2/participation/{participation-id}
Append state proof keys to a participation key
AppendKeys 1 param body → 200400401404500default
POST
/v2/shutdown
Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.
ShutdownNode 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ParticipationKey (8 properties), AccountParticipation (6 properties), DebugSettingsProf (2 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

AccountParticipation
object
AccountParticipation describes the parameters used by this account in consensus protocol.
6 properties 5 required
ParticipationKey
object
Represents a participation key used by the node.
8 properties 3 required
ErrorResponse
object
An error response with optional data field.
2 properties 1 required
DebugSettingsProf
object
algod mutex and blocking profiling state.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

algorand-private-api-openapi.yml Raw ↑

Other APIs Algorand publishes across the network.

Algorand KMD REST API
Algorand common API
Algorand Key API
Algorand lookup API
Algorand Master Key API
Algorand Multisig API
Algorand Program API
Algorand public API
Algorand search API
Algorand Swagger.json API
Algorand Transaction API
Algorand Versions API
Where this information came from

This is an independent, third-party profile of Algorand private API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.