Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to Digg

Common Request Parameters

Each action in the Alexa Web Information Service API has its own specific set of parameters, but there is also a set of parameters that all actions use. This section describes those input parameters.

ParameterDescriptionRequired

Action

The API operation, for example, UrlInfo or TrafficHistory

Type: String:

Constraint: Must be a valid action

Yes

AWSAccessKeyId

A string, distributed by Amazon when you sign up to be a developer, that uniquely identifies the caller

Type: String

Yes

Signature

A value calculated using the request parameters and a SHA256 (preferred) or SHA1 HMAC encryption algorithm

Type: String

Yes

SignatureMethod

A value that specifies the signing method

Type: String

Valid Values: HmacSHA256 (preferred) or HmacSHA1.

Yes

SignatureVersion

A value that specifies the Signature format

Type: Integer

Valid Value: 2

[Important]Important

Previous signature versions were deprecated on May 25, 2011. As of November 25, 2011 you must use signature version 2. See Calculating Signatures.

Yes

Timestamp

An IS0 8601 date-time in UTC that marks the day and time the request was sent. Requests expire after a certain length of time to prevent malicious users from capturing requests and resubmitting them at a later time.

Type: DateTime, for example, 2008-09-18T13:00:01Z

Yes

Version

The API version to use. Use the current API version number, 2005-07-11, to ensure that requests succeed even if the API changes in future versions.

Type: Date

Valid Value: 2005-07-11

No