Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neyrs.cloud/llms.txt

Use this file to discover all available pages before exploring further.

The Neyrs API provides programmatic access to intent parsing, transaction building, and portfolio tracking. Built on REST principles with JSON request/response format.

​
Base URL

https://api.neyrs.cloud/v1

​
Authentication

All API requests require authentication via Bearer token: 
Authorization: Bearer neyrs_live_abc123def456

​
Request Format

curl --request POST \
  --url https://api.neyrs.cloud/v1/sessions \
  --header 'Authorization: Bearer neyrs_live_abc123def456' \
  --header 'Content-Type: application/json' \
  --data '{
    "walletAddress": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU"
  }'

​
Response Format

All responses follow a consistent structure: 
{
  "data": {},
  "meta": {
    "requestId": "req_abc123def456",
    "timestamp": "2024-03-08T14:30:00Z"
  }
}

​
Error Responses

{
  "error": {
    "code": "validation_error",
    "message": "Invalid request parameters",
    "details": {
      "field": "walletAddress",
      "reason": "Invalid Solana address format"
    }
  },
  "meta": {
    "requestId": "req_abc123def456",
    "timestamp": "2024-03-08T14:30:00Z"
  }
}

​
Rate Limits

TierRequests/minTransactions/day
Free30100
Pro1201,000
Enterprise600Unlimited
Rate limit headers included in every response: 
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1709913600

​
Pagination

List endpoints support cursor-based pagination: 
GET /v1/messages?limit=50&cursor=msg_abc123def456
Response includes pagination metadata: 
{
  "data": [],
  "pagination": {
    "hasMore": true,
    "nextCursor": "msg_xyz789ghi012"
  }
}

​
Versioning

The API is versioned via URL path. Current version: v1 Breaking changes will be released as new versions (v2, v3, etc.)

​
SDKs

Official SDKs available:
  • TypeScript/JavaScript: npm install @neyrs-agent/sdk
  • Python: pip install neyrs-sdk
API keys can be generated from the Developer Dashboard. Store keys securely and never expose them in client-side code.