Skip to content

Query Terms

Paginated query over the project termbase. Sync response.

Endpoint

GET {BASE_URL}/api/open/v1/terms

Authentication Headers

Same as Create Translation Task. GET has no body, so signature is MD5(timestamp + "" + appSecret).

Query Parameters

ParamTypeRequiredDefaultDescription
pageintNo1Page number, 1-based
page_sizeintNo100Per-page size, max 500
categorystringNoExact-match filter on category
keywordstringNoCase-insensitive substring match on content

The source language filter is automatically resolved from the project configuration. There is no parameter for it — the response echoes the effective source_language back.

Response

json
{
  "success": true,
  "code": 0,
  "msg": "ok",
  "trace_id": "...",
  "data": {
    "page": 1,
    "page_size": 100,
    "total": 357,
    "source_language": "zh-cn",
    "items": [
      {
        "id": "69e9b99c04e32e3f20afbbdb",
        "content": "战斗力",
        "source_language": "zh-cn",
        "category": "Item",
        "pic": "",
        "translations": {
          "en": "Combat Power",
          "ja": "戦闘力",
          "ko": "전투력"
        },
        "created_at": "2026-04-21T06:12:00.000Z",
        "updated_at": "2026-04-23T08:00:03.891Z"
      }
    ]
  }
}
  • source_language: the source-language filter actually used (resolved from project config)
  • items[].id: the term row id; pass directly to /terms/update / /terms/delete
  • items[].translations: only non-empty values are included; empty / null languages are filtered out
  • Default ordering: updated_at desc, tiebreak id desc (stable pagination)

Error Codes

codeDescription
401Signature invalid / timestamp expired
403App Secret not configured
404appKey unknown
422Project has no configured source language
500Internal error

Example

bash
APP_KEY="5685414646a54423c891d87194d87f3f"
APP_SECRET="<your App Secret>"
BASE_URL="https://api.loxily.com"

TIMESTAMP=$(date +%s)
SIGN=$(printf '%s' "${TIMESTAMP}${APP_SECRET}" | md5)

curl -s -G "${BASE_URL}/api/open/v1/terms" \
  --data-urlencode "page=1" \
  --data-urlencode "page_size=200" \
  --data-urlencode "category=Item" \
  --data-urlencode "keyword=战斗" \
  -H "X-Loxily-AppKey: ${APP_KEY}" \
  -H "X-Loxily-Timestamp: ${TIMESTAMP}" \
  -H "X-Loxily-Sign: ${SIGN}"