Skip to content

1.1 - Return Structure

On Success

Every call is a GET and answers JSON, wrapped in the envelope below. On success, StatusCode is 200, Status is ESUCC, Message is the fixed text Request OK. Request OK. {0}, Debug is null and Result holds the operation's data. When the operation fails (400, 404, 405, 500 or 503), the HTTP status and StatusCode are the error's, Status is EFAIL, Message reads Request Failed. followed by the reason, and Result is null. A request refused before the operation runs (no or an invalid API key, 401; a key without access to the operation, 403; a rate limit, 429) is answered {"status": "error", "message": ...} instead.

{
     "StatusCode": 200,
     "Status": "ESUCC or EFAIL",
     "Message": "Request OK. ",
     "Debug": null,
     "Result":
          {}
}

Example

Structure varies strongly from one API endpoint to another. Please refer to dedicated articles.

Note (checked against the API on 2026-11-11)

The sample shows Message as Request OK.; the API sends Request OK. Request OK. {0}. A parameter the operation does not list is refused with a 400 that names it and lists those accepted. Every call takes an InfoTrie API key in the X-API-Key header; the legacy AppKey header is refused with a 401. Each operation is served at https://api.infotrie.com/api/idata/ followed by its name.