The Atoma Node API allows you to interact with your Atoma node, via the Atoma node daemon, for tasks, stacks and funds management. This guide will help you get started with using the API.

​
Spawn the Atoma Node Daemon

To start the Atoma Node daemon, you must start a node on your machine. In order to do so, you can follow the instructions in the Atoma node section. By spawning the node, you are able able to interact with the Atoma node API, directly from localhost.

​
Base URL

By default, the Atoma Node API is accessible at: 
http://localhost:3001
You can configure a different port by setting the ATOMA_DAEMON_PORT environment variable.

​
Available Endpoints

Atoma Node provides the following main endpoint categories:

​
Tasks

  • List Tasks: GET /tasks

​
Subscriptions

  • List Node Subscriptions: GET /subscriptions/nodes/{node_id}

​
Stacks

  • List Node Stacks: GET /stacks/nodes/{node_id}?min_fill_fraction={fraction}

​
Node Management

  • Register Node: POST /nodes/register
  • Subscribe to Model: POST /nodes/model-subscribe
  • Subscribe to Task: POST /nodes/task-subscribe
  • Update Task Subscription: POST /nodes/task-update-subscription
  • Unsubscribe from Task: DELETE /nodes/task-unsubscribe
  • Try Settle Stacks: POST /nodes/try-settle-stacks
  • Submit Attestations: POST /nodes/submit-attestations
  • Claim Funds: POST /nodes/claim-funds

​
Attestation Disputes

  • List Against Node Disputes: GET /attestation_disputes/against/nodes/{node_id}
  • List Own Node Disputes: GET /attestation_disputes/own/nodes/{node_id}

​
Claimed Stacks

  • List Node Claimed Stacks: GET /claimed-stacks/nodes/{node_id}