{apiMethod.controller.title}: {apiMethod.method.name}

{apiMethod.method.httpMethod} {apiMethod.method.httpMethod} {apiMethod.method.httpMethod} {apiMethod.method.httpMethod} {apiMethod.method.httpMethod} {apiMethod.method.fullRequestPath}

Rate limit: {apiMethod.method.rateLimit} requests per minute Your account rate limit as displayed in My Account -> API Settings * {apiMethod.method.rateLimitMultiplier}

Parameters

Name	Type	Description
{param.name}*	string
{param.name}*	{param.shortType} {param.shortType}

* indicates required field

Returns

{apiMethod.method.shortReturnType}

Exceptions

{exception.shortType}

Examples

Curl
PHP
Java


curl -H "Content-Type: application/json"
-X {apiMethod.method.httpMethod} {apiMethod.baseURL}{apiMethod.method.fullRequestPath}?apiMethodKey=YOURAPIKEY&apiMethodSecret=YOURSECRET&{param.name}=VALUE
-d '{apiMethod.method.payloadParam.shortType} JSON DATA'



use \APIProvider;

$client = new APIProvider("{apiMethod.baseURL}", "YOURAPIKEY", "YOURAPISECRET");

$result = $client->{apiMethod.controller.className}()->{apiMethod.method.name}(, ${param.name})



APIProvider client = new APIProvider("{apiMethod.baseURL}", "YOURAPIKEY", "YOURAPISECRET");

{apiMethod.method.returnJavaType} result = client.{apiMethod.controller.className}().{apiMethod.method.name}(, {param.name})