GetAccountBalance - Amazon Mechanical Turk
DescriptionRequest ParametersResponse ElementsExamples

WARNING

You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019.

If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:

This Requester API is no longer supported. Please use the latest API using the official AWS SDK. https://aws.amazon.com/getting-started/tools-sdks

The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits (SDKs) that have been widely adopted across the AWS community. This API can be accessed using the following AWS SDKs: Python/Boto (Boto3), Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++. This version also makes it easier for customers to connect MTurk with other AWS services like S3, Lambda, Step Functions, Lex, Polly, Rekognition, Amazon SageMaker, AWS Batch, EC2, and more.

This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019.

If you are on a legacy API, you must migrate to the latest version of our API. You can find documentation for the latest API here and the AWS SDKs here. Please check whether you need to migrate and review the technical migration guide.

For support, contact requestor-apilegacydeprecation-support@amazon.com.

 

GetAccountBalance

Description

The GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk account.

Request Parameters

The GetAccountBalance operation accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameter is specific to the GetAccountBalance operation:

Name Description Required

Operation

The name of the operation

Type: String

Valid Values: GetAccountBalance

Default: None

Yes

Response Elements

A successful request for the GetAccountBalance operation returns with a GetAccountBalanceResult element in the response.

The GetAccountBalanceResult element contains the following elements:

Name Description

AvailableBalance

The amount available to pay for assignments. This is your current balance minus any outstanding payments, fees or bonuses you owe.

Type: Price data structure

OnHoldBalance

Not used. This value is always 0.

Type: Price data structure

Examples

The following example shows how to use the GetAccountBalance operation.

Sample Request

The following example retrieves the Requester's account balance.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2017-01-17
&Operation=GetAccountBalance
&Signature=[signature for this request]
&Timestamp=[your system's local time]

Sample Response

The following is an example response.

<GetAccountBalanceResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <AvailableBalance>
    <Amount>10000.000</Amount>
    <CurrencyCode>USD</CurrencyCode>
    <FormattedPrice>$10,000.00</FormattedPrice>
  </AvailableBalance>
</GetAccountBalanceResult>