Skip to main content

​
Base URL

https://nearnode.io/api/v1

​
Authentication

All API requests require a Bearer token in the Authorization header: 
curl -H "Authorization: Bearer sk_live_..." https://nearnode.io/api/v1/nodes
API keys are scoped to your organization. Generate keys in the NearNode Console under Developers → API Keys.
API keys grant full access to your organization’s data. Store them securely and rotate them periodically.

​
Response Format

All responses follow a consistent structure: 
{
  "data": { ... },
  "error": null
}
Error responses: 
{
  "data": null,
  "error": "Description of what went wrong"
}

​
HTTP Status Codes

CodeMeaning
200Success
201Created
400Bad request (invalid input)
401Unauthorized (missing or invalid API key)
404Resource not found
422Validation error
429Rate limited
500Internal server error

​
Rate Limits

  • Standard: 100 requests per minute per API key
  • Batch operations: 10 requests per minute
Rate limit headers are included in every response: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1707494400

​
Endpoints

Create Node

POST /nodes — Generate a new physical touchpoint.

List Nodes

GET /nodes — Retrieve all nodes in your organization.

Get Node

GET /nodes/{slug} — Retrieve a single node.

Update Node

PATCH /nodes/{slug} — Update payload, label, or status.

Delete Node

DELETE /nodes/{slug} — Permanently delete a node.

Batches

POST /batches — Create nodes in bulk.