Home›Help

Glossary

Terms used throughout the documentation.

API key (clientKey)

A secret string that identifies your account. It is passed in every request. It is issued in the bot via the My key button. Do not share it with anyone.

task

An object describing the task: the captcha type, the page URL, the captcha key, and session parameters.

taskId

The task identifier. It is returned by the createTask method and is required for getTaskResult. A task is stored for 5 minutes.

type

The task type. HCaptchaTask is supported (HCaptchaTaskProxyless is also accepted).

hCaptcha

A "human or bot" verification service that Steam uses to protect its forms. This is the captcha we solve.

websiteURL

The full URL of the Steam page on which the captcha is shown.

websiteKey (sitekey)

The public hCaptcha key of a specific page. It is visible in the page's requests and arrives in Steam's response to refreshcaptcha.

gid

The captcha identifier that Steam returns in its response to refreshcaptcha. Single-use. It is passed in our request as data.

data

A single-use captcha parameter. For Steam, it is the gid value. After the page is refreshed, the old value is no longer valid.

refreshcaptcha

A Steam request whose response contains the gid and sitekey of the current captcha.

isInvisible

A flag indicating an invisible captcha. For Steam registration, pass true.

cookies

The cookies of your Steam session as a single string: sessionid=…; browserid=….

userAgent

The User-Agent of the browser under which your session runs. It must match the one you use when contacting Steam.

fallbackToActualUA

If true and your User-Agent is outdated, we substitute a current one and return it in solution.userAgent.

Proxy

Your own proxy server (proxyType, proxyAddress, proxyPort, proxyLogin, proxyPassword). Required if the token must be obtained from your IP.

Token (gRecaptchaResponse)

The result of solving: a string that you insert into the Steam request. Single-use, valid for 60 seconds.

processing / ready

Task statuses: being solved / solved.

Reservation

Charging the task cost to your balance when the task is created. If the task is not solved, the amount is refunded.

cost

The cost of a solved task in dollars, returned together with the solution.

Steam session

The set of cookies, User-Agent, and IP under which you work with Steam. A token is accepted only if it is used within the same session.