Introduction

The Tachapps REST API allows you to programmatically access production data, manage projects and wells, and integrate Tachapps with your own tools and pipelines.

Base URL

All API requests are made to:

https://<your-organization>.tachyus.com/api/v1

API Versioning

The current stable version is v1. The version is included in the URL path. Breaking changes are introduced only in new major versions with advance notice.

Request Format

All requests use HTTPS. Request bodies must be JSON with the Content-Type: application/json header.

POST /api/v1/projects HTTP/1.1
Host: your-org.tachyus.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Permian Basin Asset",
  "timezone": "America/Chicago",
  "unitSystem": "imperial"
}

Response Format

All responses return JSON. Successful responses use 2xx status codes. Errors return a structured error body:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Well with id 'well-999' not found.",
    "requestId": "req-abc123"
  }
}

Pagination

List endpoints support cursor-based pagination:

GET /api/v1/projects/{projectId}/wells?limit=50&cursor=<next_cursor>

Response includes a nextCursor field when more results are available:

{
  "data": [...],
  "nextCursor": "eyJpZCI6Indlb...",
  "total": 342
}

Rate Limits

Plan	Requests / minute	Burst
Standard	60	120
Professional	300	600
Enterprise	1,000	2,000

When a rate limit is exceeded, the API returns 429 Too Many Requests with a Retry-After header.

SDKs & Client Libraries

Official clients are available for:

Language	Package
Python	pip install tachapps-client
JavaScript	npm install @tachyus/tachapps-client
R	install.packages("tachapps") (CRAN)

Next Steps

• Authentication →
• Projects →
• Wells →