Signup Login

View information about your account

API Method: client_info

Description

Provides information about your account like remaining credits.

This is a free method.

Mandatory Parameters

Name Description
api_key or javascript_key Use your API key if invoking server-side. If invoking from the browser via JavaScript, generate a JavaScript key using the javascript_key method.

Returned Values

The XML response is contained within a <client_info_res> element.

Name Description
status Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code Returns the error code when the status is error. See below for error codes.
t2a_version_number The current API version number.
credit_balance

Your remaining credits.

total_credit_transactions

The number of times you have bought credits.

total_credits

The total number of credits that have been bought.

Error Codes

See the common error codes. There are no errors which are specific to this method.

Example XML Response


<?xml version="1.0"?>
<client_info_res>
	<mode>normal</mode>
	<status>ok</status>
	<credit_used>0</credit_used>
	<t2a_version_number>2.6.0.1</t2a_version_number>
	<credit_balance>127</credit_balance>
	<total_credit_transactions>2</total_credit_transactions>
	<total_credits>1700</total_credits>
</client_info_res>