account::get_balance

1. Index
2. > Function reference
3. > account::get_balance

Description

Get account balance at any time.

Request details

• Method

  GET

• URL

  https://api.hostingreborn.com/account/get_balance/

Arguments

key

API key

datetime (optional)

Specify the date, time or date and time for which to retrieve an account balance.

Use almost any date and time format, as well as almost any English textual representation of an absolute or relative date. Refer to the GNU date input format documentation for full details.

The current date and time is used if nothing is specified, or is specified but cannot be understood.

Responses

<?xml version="1.0" encoding="utf-8"?>
<result>
  <datetime>2008-08-04 07:00:00</datetime>
  <balance>958.995056125</balance>
</result>
	

datetime

The date and time for which the balance has been retrieved

balance

Balance in pence

Exceptions

• database

• access

Examples

Get current balance

GET /account/get_balance/?key=acbd18db4cc2f85cedef654fccc4a4d8

<?xml version="1.0" encoding="utf-8"?>
<result>
  <datetime>2008-08-04 07:00:00</datetime>
  <balance>958.995056125</balance>
</result>
	

Get balance on 1st May 2008

GET /account/get_balance/?key=acbd18db4cc2f85cedef654fccc4a4d8&datetime=2008-05-01

<?xml version="1.0" encoding="utf-8"?>
<result>
  <datetime>2008-05-01 00:00:00</datetime>
  <balance>427.825</balance>
</result>
	

GET /account/get_balance/?key=acbd18db4cc2f85cedef654fccc4a4d8&datetime=1st May 2008

<?xml version="1.0" encoding="utf-8"?>
<result>
  <datetime>2008-05-01 00:00:00</datetime>
  <balance>427.825</balance>
</result>
	

Get balance relative to current date (current date assumed to be 4th August 2008, 10:35 am)

GET /account/get_balance/?key=acbd18db4cc2f85cedef654fccc4a4d8&datetime=+1 week

<?xml version="1.0" encoding="utf-8"?>
<result>
  <datetime>2008-08-11 10:35:00</datetime>
  <balance>623.44656</balance>
</result>
	

GET /account/get_balance/?key=acbd18db4cc2f85cedef654fccc4a4d8&datetime=-1 week

<?xml version="1.0" encoding="utf-8"?>
<result>
  <datetime>2008-07-28 10:35:00</datetime>
  <balance>339.4458</balance>
</result>
	

See also

• account::get

  Get summary details (email address, balance, status) for an account