Skip to main content
GET
/
v1
/
orders
ListOrders
curl --request GET \
  --url https://api.nitrotranslate.com/v1/orders \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": 123,
    "source_language": "<string>",
    "target_language": "<string>",
    "snippet": "<string>",
    "volume": 123,
    "price": 123,
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

sort
enum<string>

Sort by creation time: "asc" or "desc" (default).

Available options:
asc,
desc
page
integer<int32>

Zero-based page index. Defaults to 0.

Required range: x >= 0
per_page
integer<int32>

Page size. Defaults to 20.

Required range: x >= 1

Response

200 - application/json

Success

id
status
enum<string> | null

Lifecycle status: QUEUE -> PROGRESS -> DONE. REVISION marks a completed order pending revision; active rework reports as PROGRESS again.

Available options:
QUEUE,
PROGRESS,
DONE,
REVISION
source_language
string
target_language
string
snippet
string

Short preview of the source text. ListOrders only.

volume
integer<int32>

Billable character volume.

price
number<double>

Order price in US dollars. Always returned.

created_at
string<date-time>