ANNE Node API | Hypergraph API | Datachain API Reference
Complete API Reference for Building on ANNE
The ANNE Node API exposes a comprehensive HTTP/HTTPS interface to your local ANNODE, providing programmatic access to all core network functions. This includes hypergraph queries for semantic data, datachain operations for transactions and consensus, alt-data messaging for application-specific payloads, and ANTOR file transfers. The complete API reference is available locally at http://localhost:9116/api-doc and can be accessed remotely with appropriate authentication.
The hypergraph API enables direct querying of neurons and relons across multiple semantic dimensions, allowing applications to retrieve and traverse the knowledge graph. The datachain API provides methods for transaction creation, balance checks, and mining operations. Additional endpoints support encrypted peer messaging, file distribution, and administrative functions. All interactions are authenticated through cryptographic signatures, ensuring that data sovereignty remains with the node operator.
Applications built on this API follow a local-first model: they communicate exclusively with the user’s own ANNODE, which in turn negotiates with the broader peer-to-peer network. This architecture eliminates dependencies on third-party services and gives developers direct control over their application stack. The following sections document each endpoint, including required parameters.
http://localhost:9116/api-doc. You’ll find a vast arsenal of ANNE libraries and applications using API functions and Websockets at http://localhost:9116/ANNE.html and http://localhost:9116/aon.html
Join us at ANNE Talk for help with development and ANNE testnet configuration.
Categories: ADF
Categories: AAUTH
Categories: AAUTH
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Messages Localhost only
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Messages
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: A2A
Categories: A2A
Categories: A2A
Categories: A2A
Categories: Transactions
Categories: ANNE Hypergraph
Categories: Transactions
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Server Peer Info Localhost only
Categories: Administrator
Categories: Debug Utils ANNE Hypergraph
Categories: Debug Utils ANNE Hypergraph
debug antor
Debug antor by viewing the relevant annode config properties
Categories: Debug Utils
Categories: Debug Utils
Categories: Debug Utils
Categories: Debug Utils
Categories: Debug Utils ANNE Hypergraph
Categories: Debug Utils
Categories: Debug Utils
Categories: Debug Utils ANNE Hypergraph
Categories: ANTOR Debug Utils
Categories: Debug
debug : signed-to-unsigned
All nids are signed longs under the hood. Convert negative txids or nids from log views or the db into their positive display user-friendly (app-facing) nid long string. To convert from user-friendly unsigned to get the actual signed long, use debug_unsignedToSigned.
Parameters:
|
signed_long
required |
long
|
The signed long version of any nid or txid |
debug : signed-to-unsigned
Convert a user-friendly display string of account id, nid, or txid into the back-end used signed long found int he DB tables and logs. To convert from signed long to unsigned user-friendly display, use debug_signedToUnsigned.
Parameters:
|
unsigned_longstring
required |
string
|
The unsigned display-friendly longstring version of any nid or txid |
Categories: Messages
Categories: A2A
Categories: Messages Localhost only
Categories: legacy Utils
Categories: legacy Utils
Categories: Create Transaction legacy Transactions
Categories: A2A
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Accounts
Categories: Accounts
Categories: Accounts
Categories: Accounts
Categories: Accounts
Categories: Accounts
Categories: Accounts
Categories: ANTOR Files Localhost only
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Get all my stuff
Get all relons pertaining to a NID for use in apps. This gets stuff from / to the NID.
Parameters:
|
nid
required |
string
|
Neuron ID – unique nid. Use the always-positive unsigned NID long, as a string. |
|
height
required |
integer
|
Filter by height/depth level in the graph structure, 0 for get all |
|
limit
required |
integer
|
Maximum number of results to return (default: 100, max: 500) |
|
offset
required |
integer
|
Number of results to skip for pagination (default: 0) |
Get all my stuff, sponsored/owned
Get all relons pertaining to a NID for use in apps. This gets sponsored and owned stuff.
Parameters:
|
nid
required |
string
|
Neuron ID – unique nid. Use the always-positive unsigned NID long, as a string. |
|
height
required |
integer
|
Filter by height/depth level in the graph structure, 0 for get all |
|
sponsored
required |
boolean
|
If set, will include sponsored neurons |
|
limit
required |
integer
|
Maximum number of results to return (default: 100, max: 500) |
|
offset
required |
integer
|
Number of results to skip for pagination (default: 0) |
Categories: ANNE Hypergraph
Get all numes for nid
Get all the numes that a NID.
Parameters:
|
nid
required |
string
|
Neuron ID – unique nid. Use the always-positive unsigned NID long, as a string. |
|
height
required |
integer
|
Filter by height/depth level in the graph structure, 0 for get all |
|
limit
required |
integer
|
Maximum number of results to return (default: 100, max: 500) |
|
offset
required |
integer
|
Number of results to skip for pagination (default: 0) |
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: A2A
Categories: A2A
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Get balance
Get the balance of a known ANNE account/neuron. Accounts are blockchain-side and account ids are the same as the NID on the hypergraph side.
Parameters:
|
account
required |
string
|
The account id (same as NID) |
Categories: Blocks
Categories: Blocks
Categories: Blocks
Categories: Blocks
Categories: Server Info Blocks
Categories: Transactions
Categories: Transactions Localhost only
Categories: Blocks
Categories: Blocks
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: legacy Server Info
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Blocks
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Transactions
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Utils Server Info Mining
Categories: Utils Server Info Mining Mining V3
Categories: A2A
Categories: legacy Server Info
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Get balance
Get the balance of a known ANNE account/neuron. More robust than getBalance as this returns key account and neuron information.
Parameters:
|
account
required |
string
|
The account id (same as NID) |
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Server Info
Categories: Server Info
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: A2A Localhost only
Categories: ANNE Hypergraph
Categories: Messages
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Server Info
Categories: ANNE Hypergraph
Categories: Blocks
Categories: Transactions ANNE Hypergraph
Categories: Server Info
Categories: ANNE Hypergraph
Categories: Transactions
Categories: Accounts
Categories: Blocks
Categories: Transactions Accounts
Categories: Transactions Accounts
Categories: ANNE Hypergraph
Categories: Files
Categories: Mining METADATA
Categories: ANNE Hypergraph
Categories: Error Reporting Experimental
Categories: ADF
latest releases
Latest release file nids pulled from the hypergraph used to support file downloads and key annode file distribution.
Local Annode File Upgraded Cleanup
A local-only annode file has been converted to a ghost in an ANNE app and then broadcast. Clean up local-only annode memory and move the file.
Parameters:
|
old_nid
required |
string
|
Neuron ID – unique nid. The old 999999 prefixed local-only annode nid that was upgraded. |
|
new_nid
required |
string
|
Neuron ID – unique nid. The new nid of the real file that was just upgraded. |
|
ext
required |
string
|
the file extension |
Categories: Files ANNE Hypergraph A2A Localhost only
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph Payment relons
Categories: ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction Transactions Administrator Accounts Localhost only
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction Transactions Accounts Localhost only
Categories: Create Transaction ANNE Hypergraph
Categories: Create Transaction Transactions Administrator Accounts Localhost only
Categories: Create Transaction ANNE Hypergraph
Categories: ANTOR Files Localhost only
Categories: Server Peer Info
Categories: Messages Server Peer Info Localhost only
Categories: Transactions
Categories: A2A
Pop Off
Pops off blocks in the event of need for manual rollback.
Parameters:
|
numBlocks
optional |
integer
|
Number of blocks to popoff. Either this or height is required. |
|
height
required |
integer
|
Filter by height/depth level in the graph structure, 0 for get all |
|
apiKey
required |
string
|
Your secret API key intended to ONLY be used on localhost as whatever this key is will be seen in plain text if sent across the wire remotely. |
Categories: ANTOR Files Localhost only
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Query for the child instances of a parent class
Retrieves the direct child neurons of a neuron.
Parameters:
|
nid
required |
string
|
Neuron ID – unique nid. Use the always-positive unsigned NID long, as a string. |
|
offset
required |
integer
|
Number of results to skip for pagination (default: 0) |
|
height
required |
integer
|
Filter by height/depth level in the graph structure, 0 for get all |
|
limit
required |
integer
|
Maximum number of results to return (default: 100, max: 500) |
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Messages
Categories: Messages
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: ANNE Hypergraph
Categories: Messages Localhost only
Categories: ANNE Hypergraph Localhost only
Categories: ALTDATA
Categories: ALTDATA Localhost only
Send Annee
Create a message transaction to a recipient. Js app will sign and broadcast. See SendAnneLocalhostAdmin to create, sign and broadcast TX in one go.
Parameters:
|
recipient
required |
string
|
Recipient account ID or address |
|
message
required |
string
|
The messsage to be sent |
|
encrypt
optional |
boolean
|
A flag indicating the message will be encrypted |
|
publicKey
required |
hex string
|
The hexstring public key of the sender nid |
|
feeNQT
required |
long
|
Transaction fee in smallest currency units (optional) |
|
deadline
optional |
int
|
Typically 1440 |
|
recipientPublicKey
required |
hex string
|
The hexstring public key of the sender nid |
|
referencedTransactionFullHash
optional |
string
|
The hex string hash of the referenced transaction that serves as a pre-requisite to be mined before this transaction can be processed. |
Categories: Create Transaction Transactions Accounts Localhost only
Categories: Create Transaction ANNE Hypergraph
Send Message
Creates and sends a message transaction to a recipient.
Parameters:
|
recipient
required |
string
|
Recipient account ID or address |
|
message
required |
string
|
The messsage to be sent |
|
feeNQT
required |
long
|
Transaction fee in smallest currency units (optional) |
|
deadline
optional |
int
|
Typically 1440 |
Categories: A2A
Categories: Create Transaction ANNE Hypergraph
Categories: Files
Categories: Messages
Categories: Transactions
Categories: Mining
Categories: Mining Mining V3
Categories: Server Peer Info Localhost only
Categories: Files ANNE Hypergraph Localhost only
Categories: Files ANNE Hypergraph Localhost only
Categories: Messages
Categories: Messages
Categories: Messages
Categories: Create Transaction ANNE Hypergraph
ANNE Node API Categories: API Reference for Building on the ANNE Protocol Stack

ANNE Node API Reference
Hypergraph · Datachain · A2A Messaging · ANTOR File Transfer · Alt Data
Unified HTTP/HTTPS interface to all subsystems of your personal server. Build sovereign, local‑first applications on the ANNE protocol stack.
The ANNE Node API provides a unified HTTP/HTTPS interface to all subsystems of your personal server. This section details each functional category, explaining how they enable developers to build decentralized applications that interact with the neuromorphic hypergraph, the datachain, file distribution networks, and peer-to-peer messaging layers. By understanding the organization of the API, you can efficiently navigate the available endpoints and integrate them into your own local‑first applications.
Hypergraph API: Querying the Semantic Knowledge Graph
The hypergraph API grants direct access to the neuromorphic hypergraph, a dense, queryable structure composed of neurons (conceptual nodes) and relons (typed, directed edges). Through these endpoints, applications can retrieve semantic data across multiple dimensions such as TYPE_BE (class-instance hierarchies), TYPE_HAS (attribute values), TYPE_AWARENESS (subjective feedback), and TYPE_EXPERIENCE (temporal events). The hypergraph API is the primary means of traversing the knowledge graph, enabling pattern discovery, semantic search, and contextual reasoning.
Key endpoints include getAllMyStuff, which returns all relons associated with a given neuron, and queryForOuts / queryForIns, which fetch outgoing or incoming relationships filtered by type. More advanced queries such as hypergraphSearchWithRelons allow pattern matching against multiple relationship criteria. By leveraging the hypergraph API, applications can build user interfaces that present interconnected knowledge, recommend related content based on semantic proximity, and even perform lightweight inference using rules stored in the BRAIN dimension.
Datachain API: Interacting with the Proof‑of‑Space‑Time Blockchain
The datachain API provides endpoints for all blockchain-related operations, including querying blocks, retrieving transactions, checking account balances, and submitting new transactions. The underlying consensus mechanism is Proof‑of‑Space‑Time (PoST), which combines storage commitments with verifiable delay functions to achieve deterministic finality. Through the datachain API, applications can anchor data immutably, transfer value, and participate in network governance.
Important endpoints include getBlock (by height or ID), getAccount (balance and public key), getTransaction (retrieve a specific transaction), and transaction creation calls such as sendAnne for payments and sendSelfRelon for broadcasting semantic assertions. For nodes that opt to mine, the datachain API also exposes submitNonce and getMiningInfo to participate in block generation. All transaction submissions require cryptographic signing, ensuring that only the key holder can authorize operations.
Additional ANNE Node API Categories
Beyond the core hypergraph and datachain layers, the ANNE Node API encompasses several other vital subsystems. Each category addresses a specific aspect of decentralized application development, from identity management to real‑time data distribution.
Accounts
The Accounts category handles identity neurons (keyed or keyless). Endpoints such as getAccount, getAccountPublicKey, and getAccountId allow applications to retrieve public keys and neuron identifiers. For administrative tasks, endpoints like makeKeylessNeuron create new keyless neurons, while sendAnne and sendMessage facilitate value transfer and encrypted messaging.
A2A (Annode‑to‑Annode) Messaging
Secure peer-to-peer communication is provided through the A2A subsystem. Endpoints like sendMsgForSesh and getMsgsForSesh enable encrypted messaging between nodes, with session management and message history. This layer is essential for building chat applications, collaborative tools, and any decentralized interaction that requires direct, authenticated channels.
ANTOR File Transfer
The ANTOR protocol enables swarm‑based distribution of large files. The API includes endpoints for initiating transfers (preloadAntor), checking status (getActiveAntors), and serving files (serveFile). Real‑time progress can be monitored via WebSocket subscriptions (onantor and onantorant). Files are stored in segregated directories (a2a_neurons, a2a_cache, a2a_localonly), with access controlled by the node operator.
Alt Data Network
Application‑specific unstructured payloads are handled by the Alt Data Network. Endpoints such as sendAltData publish messages to the mesh, while WebSocket subscriptions allow clients to receive real‑time updates. Each payload is typed with hierarchical identifiers (adtype, adsubtype), enabling applications to create custom data types. The Alt Data API is ideal for configuration distribution, live event streams, and any data that does not fit the 1Schema model.
Mining
For nodes participating in consensus, the Mining category provides endpoints for submitting deadlines (submitNonce), retrieving mining information (getMiningInfo), and debugging share‑mining state (debug_ShareMiners). These endpoints support both solo and share mining, allowing node operators to earn block rewards.
Administrator & Debug
Localhost‑only endpoints (flagged with the “Localhost only” tag) provide administrative functions such as node configuration, database maintenance (popOff for chain reorganization), and file cleanup (nukeFileData). Debug endpoints (debug_clocktime, debug_signedToUnsigned) assist developers in testing and troubleshooting. These endpoints are protected by configuration flags and should never be exposed remotely.
Transactions
Separate from the datachain API, the Transactions category focuses on transaction construction, signing, and broadcasting. Endpoints like broadcastTransaction accept signed transaction bytes, while signTransaction and parseTransaction help clients prepare valid transactions. The sendAnne and sendMessage endpoints are also part of this category, providing higher‑level interfaces for common operations.
Utils & Debug
A collection of utility endpoints assists with common tasks: converting between signed and unsigned NID representations (debug_signedToUnsigned), retrieving network constants (getConstants), and generating QR codes for transactions (generateSendTransactionQRCode). These endpoints simplify development and integration.
The ANNE Node API thus provides a comprehensive, modular interface to all ANNE subsystems. Whether you need to query the hypergraph API for semantic relationships, interact with the datachain API for immutable records, transfer files via ANTOR, or publish real‑time data through the Alt Data Network, the API reference on this page documents every available endpoint with parameters, response formats, and examples. By building on this API, developers create applications that are sovereign, local‑first, and fully integrated into the decentralized ecosystem.
All endpoints are accessible at http://localhost:9116/anne (or https://your-annode-address with appropriate authentication). Real‑time features require WebSocket connections to the altdata and antor endpoints. For detailed protocol specifications, refer to the 1Schema, PoST, Neuromorphic Hypergraph, Alt Data Network, and ANTOR whitepapers.
Deep Dive: The ANNE node API and Its Core Components
The ANNE Node API is the primary interface for interacting with a personal server in the ANNE network. It provides a unified gateway to all underlying subsystems, including the datachain, the neuromorphic hypergraph, and various peer‑to‑peer communication layers. This API reference is designed to help developers understand each endpoint, its parameters, and expected responses, enabling the creation of decentralized applications that are both powerful and sovereign.
At the core of the ANNE stack lies the hypergraph API, which exposes the neuromorphic hypergraph - a semantic knowledge graph built from neurons and relons. Through this API, developers can traverse relationships, retrieve attribute values, and query across multiple dimensions such as TYPE_BE, TYPE_HAS, and TYPE_AWARENESS. The hypergraph API transforms raw blockchain data into meaningful, interconnected knowledge, enabling applications to perform semantic search, inference, and pattern discovery without relying on external indexes or centralized services.
Complementing the semantic layer is the datachain component, which provides the immutable foundation for all transactions and consensus. The node API includes comprehensive endpoints for interacting with the datachain: querying blocks, retrieving transaction histories, checking account balances, and submitting new transactions. By leveraging the datachain, developers can anchor data permanently, transfer value securely. The datachain API is essential for any application that requires verifiable, timestamped records or economic incentives.
This API reference also covers several auxiliary subsystems that work in concert with the hypergraph and datachain. The A2A (Annode‑to‑Annode) endpoints enable encrypted peer messaging, establishing secure communication channels between nodes. The ANTOR API handles swarm‑based file transfer, allowing large payloads to be distributed efficiently across the network. The Alt Data API manages application‑specific unstructured data, providing real‑time publish‑subscribe capabilities. Together, these interfaces form a complete toolkit for building decentralized applications, all accessible through a consistent HTTP/HTTPS interface.
Get started by installing your ANNE Node and navigate to http://localhost:9116/api-doc to explore the live documentation. All calls are available locally, and you can experiment with real‑time WebSocket subscriptions for the Alt Data and ANTOR subsystems. The API reference is continuously updated as the network evolves.
Beyond this API reference, the ANNODE includes a vast arsenal of ANNE libraries accessible through applications web interface. Navigate to http://localhost:9116/ANNE.html to explore a suite of tools that demonstrate real‑world usage of the hypergraph API, datachain transactions, and file transfers. The http://localhost:9116/aon.html interface provides additional utilities for interacting with the network. These pages serve as both working examples and practical tools. Developers can inspect their source and adapt them for custom projects.
The ANNE Node API unifies the datachain, hypergraph API, and supporting services into a coherent interface that empowers developers to build truly decentralized applications. By understanding each component - from the immutable datachain to the semantic hypergraph - you can create software that respects user sovereignty, leverages peer‑to‑peer infrastructure, and contributes to a resilient, self‑sustaining digital commons.
Browse ANNE Library

support the movement
Want to help build the future? Becoming an early supporter is one of the most direct ways to contribute. By swapping for annecoin you're not just acquiring another token, you're helping to build the distributed data infrastructure that makes personal sovereignty possible for everyone
You can choose from monero, bitcoin, bitcoin cash, litecoin, ethereum, solana, or tether, and through the development fund you get annecoin in return. The fund gets resources to keep building, you get a stake in the present and future you're reading about.
Swaps are available at anne.network for anyone without a node, but if you're already running your own annode, you can swap directly from localhost at http://localhost:9116/aon.html through the alt data network. Either way it's the same peer to peer trade, permissionless and direct, your support keeps the community building.


