canonical: https://jentic.com/apis/eos.local/eos-local

# Eos Net API

Jentic publishes the only available OpenAPI specification for Net API, keeping it validated and agent-ready. The Net API is the peer-networking control plane exposed by an EOSIO node, providing four endpoints for inspecting peer connections, opening or closing connections to specific peers, and reading current network status. It targets node operators who need to script connection management against a local nodeos instance running at the configurable host and port. All operations are POST requests against the local node and require no authentication because the endpoint is bound to a private interface.

## For AI agents

Inspect and control EOSIO peer-to-peer network connections on a local nodeos node. Query peer status, connect to or disconnect from specific peers, and read network sync state.

## Scope

Does not handle smart-contract execution, transaction submission, or block production - use for nodeos peer-to-peer connection management only.

## Capabilities

- List every active peer connection on the local nodeos node with sync and handshake details
- Open a new peer-to-peer connection to a specific host and port
- Disconnect from a named peer to drop unwanted or stale connections
- Read current network status including handshake metadata and sync state
- Inspect chain_id, node_id, and last_handshake fingerprints reported by each peer

## Use cases

### Operating an EOSIO Block Producer Node

Block producers and node operators need to keep a healthy mesh of peer connections to stay in sync with the chain. The Net API exposes the four operations (connections, connect, disconnect, status) needed to script peer rotation, drop misbehaving peers, and confirm sync state without dropping into the nodeos CLI. Operators run it against a local-only port for safety.

Example prompt: Call POST `/net/connections`, parse the array, and disconnect any peer where connecting=true and last_handshake.time is older than 10 minutes.

### Local Network Diagnostics for Chain Sync Issues

When an EOSIO node falls behind the head block, operators need to confirm whether peers are actually syncing or stalled. The `/net/status` and `/net/connections` endpoints together provide the chain_id, node_id, and per-peer syncing flags needed to diagnose connectivity faults in seconds.

Example prompt: Call POST `/net/status`, then POST `/net/connections`, and report the count of peers with syncing=true alongside the head-block-num field.

### AI Agent Node Operations Assistant via Jentic

An AI ops agent can be wired through Jentic to act as an EOSIO node-watch tool: search 'list eos peer connections', load the operation schema, and execute against the operator's nodeos endpoint. Because the nodeos host and port are spec variables, the agent supplies them at execution time without code changes.

Example prompt: Use Jentic to find the connections operation, load its schema, and execute against host=localhost, port=8080 to return the live peer list.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/net/connections` | List all current peer connections |
| POST | `/net/connect` | Connect to a new peer |
| POST | `/net/disconnect` | Disconnect from a peer |
| POST | `/net/status` | Read network status and handshake metadata |

## Key resources

- **Connections** — Active peer-to-peer connections with handshake and sync metadata
- **Connect** — Open a new outbound connection to a peer
- **Disconnect** — Tear down an existing peer connection
- **Status** — Network status including chain_id and node_id handshake details

## Why Jentic

- **Setup:** Wiring the nodeos Net API by hand means pointing at the right protocol, host, and port for your node and building your own retries, even though the endpoints take no key. Through Jentic you install once, import the Net API from the API Directory, store the node target once, and your agent calls it.
- **Permission scoping:** The Net API carries the peer address in the request body rather than the URL, so scope the agent to the operations it needs, such as POST `/net/status` or POST `/net/connections.` You pick that allowed set, so an operation like POST `/net/disconnect` is only reachable if you include it.
- **Credential handling:** The Net API has no key, so there is no secret to expose; your node's host and port are stored once as configuration by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list eos peer connections' or 'check nodeos network status', and Jentic returns the matching Net operation with its input schema so the agent calls the right endpoint without reading the EOSIO source.

## Related APIs

- **U.S. EPA ECHO Clean Air Act** — Public-data REST API - different domain but illustrative of authenticated public services agents may chain with internal node data
- **EODHD Financial Data API** — Market data API - useful when correlating chain activity with traditional asset prices
- **Escrow.com API** — Off-chain escrow service - pairs with on-chain transaction monitoring for hybrid settlement flows

## FAQ

### Why is there no official OpenAPI spec for Net API?

EOSIO does not publish an OpenAPI specification for the nodeos Net plugin. Jentic generates and maintains this spec so that AI agents and developers can call the Net API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Net API use?

The Net API has no authentication scheme defined in the spec because it is intended to bind to a private host and port on the operator's machine. Through Jentic the host and port are stored as scoped configuration so multiple operators can target their own nodes safely.

### Can I list active peer connections with the Net API?

Yes. POST `/net/connections` returns an array of peer objects with peer host, connecting flag, syncing flag, and the last_handshake structure containing chain_id and node_id.

### What are the rate limits for the Net API?

The nodeos process does not enforce HTTP rate limits on the Net plugin; throughput is bounded by the local node's CPU and the configured http-max-response-time-ms. Treat it as a local administrative endpoint and avoid tight polling loops.

### How do I add a new peer through Jentic?

Search 'connect to eos peer'. Jentic returns the POST `/net/connect` operation, you load its schema, and execute with the peer host:port string. The scoped nodeos endpoint variable is injected at run time.

### Can the Net API report which chain my node is on?

Yes. POST `/net/status` returns the handshake fields including chain_id, which uniquely identifies the chain the node is connected to.

### Can I limit what my agent is allowed to do with the EOSIO Net API?

Yes. Because you run Jentic One yourself, your own rules decide which Net operations the agent can reach, so you can allow read-only calls like POST `/net/status` and POST `/net/connections` while withholding the rest. State-changing operations such as POST `/net/connect` and POST `/net/disconnect` are only callable if you add them to that allowed set. Your node's host and port are stored once as configuration by your own instance and injected at execution time, never entering the agent's prompt or logs.
