Skip to content
This repository was archived by the owner on Mar 5, 2021. It is now read-only.

Commit 8c80afb

Browse files
imagetyperz-apiimagetyperz-api
committed
end of life
1 parent fb4c4b7 commit 8c80afb

File tree

1 file changed

+3
-218
lines changed

1 file changed

+3
-218
lines changed

‎readme.md

+3-218
Original file line numberDiff line numberDiff line change
@@ -3,225 +3,10 @@ imagetyperz-api-python2 - Imagetyperz API wrapper
33

44
imagetyperzapi2 is a super easy to use bypass captcha API wrapper for imagetyperz.com captcha service
55

6-
## Installation
7-
git clone https://github.com/imagetyperz-api/imagetyperz-api-python2
6+
## DEPRECATED
7+
Library won't receive further updates starting 1 january 2021, because python2.7 reached it's [end of life](https://www.python.org/doc/sunset-python-2/).
88

9-
## Usage
10-
11-
Simply require the module, set the auth details and start using the captcha service:
12-
13-
``` python
14-
from imagetyperzapi2.imagetyperzapi import ImageTyperzAPI
15-
```
16-
Set access_token for authentication:
17-
18-
``` python
19-
access_token = 'access_token_here'
20-
# get access token from: http://www.imagetyperz.com/Forms/ClientHome.aspx
21-
ita = ImageTyperzAPI(access_token) # init imagetyperz api obj
22-
```
23-
Once you've set your authentication details, you can start using the API.
24-
25-
**Get balance**
26-
27-
``` python
28-
balance = ita.account_balance() # get account balance
29-
print ('Balance: {}'.format(balance)) # print balance
30-
```
31-
32-
## Solving
33-
For solving a captcha, it's a two step process:
34-
- **submit captcha** details - returns an ID
35-
- use ID to check it's progress - and **get solution** when solved.
36-
37-
Each captcha type has it's own submission method.
38-
39-
For getting the response, same method is used for all types.
40-
41-
42-
### Image captcha
43-
44-
``` python
45-
captcha_id = ita.submit_image('captcha.jpg')
46-
```
47-
(with optional parameters)
48-
```python
49-
captcha_id = ita.solve_captcha('captcha.jpg', is_case_sensitive = False, is_phrase = False, digits_only = False, letters_only = True, is_math = False, min_length = 2, max_length = 10)
50-
```
51-
ID is used to retrieve solution when solved.
52-
53-
**Observation**
54-
It works with URL instead of image file too, but authentication has to be done using token.
55-
56-
### reCAPTCHA
57-
58-
For recaptcha submission there are two things that are required.
59-
- page_url (**required**)
60-
- site_key (**required**)
61-
- type - can be one of this 3 values: `1` - normal, `2` - invisible, `3` - v3 (it's optional, defaults to `1`)
62-
- v3_min_score - minimum score to target for v3 recaptcha `- optional`
63-
- v3_action - action parameter to use for v3 recaptcha `- optional`
64-
- proxy - proxy to use when solving recaptcha, eg. `12.34.56.78:1234` or `12.34.56.78:1234:user:password` `- optional`
65-
- user_agent - useragent to use when solve recaptcha `- optional`
66-
- data-s - extra parameter used in solving recaptcha `- optional`
67-
68-
``` python
69-
captcha_params = {
70-
'page_url' : 'example.com',
71-
'sitekey' : '6FDDs34g3321-3234fgfh23rv32fgtrrsv3c',
72-
#'type' : 2, # optional, 1 - normal recaptcha, 2 - invisible recaptcha, 3 - v3 recaptcha, default: 1
73-
#'v3_min_score' : .3, # optional
74-
#'v3_action' : 'homepage', # optional
75-
#'proxy': '126.45.34.53:345', # optional, or 126.45.34.53:123:joe:password
76-
#'user_agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0', # optional
77-
#'data-s': 'data-s-value-here' # optional
78-
}
79-
captcha_id = ita.submit_recaptcha(captcha_params)
80-
```
81-
ID will be used to retrieve the g-response, once workers have
82-
completed the captcha. This takes somewhere between 10-80 seconds.
83-
84-
Check **Retrieve response**
85-
86-
### GeeTest
87-
88-
GeeTest is a captcha that requires 3 parameters to be solved:
89-
- domain
90-
- challenge
91-
- gt
92-
93-
The response of this captcha after completion are 3 codes:
94-
- challenge
95-
- validate
96-
- seccode
97-
98-
**Important**
99-
This captcha requires a **unique** challenge to be sent along with each captcha.
100-
101-
```python
102-
captcha_params = {
103-
'domain' :'https://your-site.com',
104-
'challenge': 'eea8d7d1bd1a933d72a9eda8af6d15d3',
105-
'gt': '1a761081b1114c388092c8e2fd7f58bc',
106-
# 'proxy': '126.45.34.53:345', # or 126.45.34.53:123:joe:password
107-
# 'user_agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0' # optional
108-
}
109-
captcha_id = ita.submit_geetest(captcha_params)
110-
```
111-
112-
Optionally, you can send proxy and user_agent along.
113-
114-
### hCaptcha
115-
116-
Requires page_url and sitekey
117-
118-
```python
119-
captcha_params = {
120-
'page_url': 'https://your-site.com',
121-
'sitekey': '8c7062c7-cae6-4e12-96fb-303fbec7fe4f',
122-
# 'proxy': '126.45.34.53:345', # or 126.45.34.53:123:joe:password
123-
# 'user_agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0', # optional
124-
}
125-
captcha_id = ita.submit_hcaptcha(captcha_params)
126-
```
127-
128-
### Capy
129-
130-
Requires page_url and sitekey
131-
132-
```python
133-
captcha_params = {
134-
'page_url': 'https://your-site.com',
135-
'sitekey': 'Fme6hZLjuCRMMC3uh15F52D3uNms5c',
136-
# 'proxy': '126.45.34.53:345', # or 126.45.34.53:123:joe:password
137-
# 'user_agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0', # optional
138-
}
139-
captcha_id = ita.submit_capy(captcha_params) # submit captcha first, to get ID
140-
```
141-
142-
### Tiktok
143-
144-
Requires page_url cookie_input
145-
146-
```python
147-
captcha_params = {
148-
'page_url': 'https://tiktok.com',
149-
# make sure `s_v_web_id` cookie is present
150-
'cookie_input': 's_v_web_id:verify_kd6243o_fd449FX_FDGG_1x8E_8NiQ_fgrg9FEIJ3f;tt_webid:612465623570154;tt_webid_v2:7679206562717014313;SLARDAR_WEB_ID:d0314f-ce16-5e16-a066-71f19df1545f;',
151-
# 'proxy': '126.45.34.53:345', # or 126.45.34.53:123:joe:password
152-
# 'user_agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0', # optional
153-
}
154-
captcha_id = ita.submit_tiktok(captcha_params) # submit captcha first, to get ID
155-
```
156-
157-
## Retrieve response
158-
159-
Regardless of the captcha type (and method) used in submission of the captcha, this method is used
160-
right after to check for it's solving status and also get the response once solved.
161-
162-
It requires one parameter, that's the **captcha ID** gathered from first step.
163-
164-
```python
165-
response = ita.retrieve_response(captcha_id)
166-
```
167-
168-
```python
169-
# get a captcha_id first
170-
captcha_id = ita.submit_recaptcha(captcha_params) # submit captcha first, to get ID
171-
172-
# check if it's still in progress (waiting to be solved), every 10 seconds
173-
print('Waiting for captcha to be solved ...')
174-
response = None
175-
while not response: # while it's still in progress
176-
sleep(10) # sleep for 10 seconds and recheck
177-
response = ita.retrieve_response(captcha_id)
178-
print('Response: {}'.format(response)) # print response of captcha
179-
```
180-
The response is a JSON object that looks like this:
181-
```json
182-
{
183-
"CaptchaId": 176707908,
184-
"Response": "03AGdBq24PBCbwiDRaS_MJ7Z...mYXMPiDwWUyEOsYpo97CZ3tVmWzrB",
185-
"Cookie_OutPut": "",
186-
"Proxy_reason": "",
187-
"Recaptcha score": 0.0,
188-
"Status": "Solved"
189-
}
190-
```
191-
192-
## Other methods/variables
193-
194-
**Affiliate id**
195-
196-
The constructor accepts a 2nd parameter, as the affiliate id.
197-
``` python
198-
ita = ImageTyperzAPI(access_token, 123) # 123 is the affid
199-
```
200-
201-
**Requests timeout**
202-
203-
As a 3rd parameter in the constructor, you can specify a timeout for the requests (in seconds)
204-
``` python
205-
ita = ImageTyperzAPI(access_token, 123, 60) # sets timeout to 60 seconds
206-
```
207-
208-
**Set captcha bad**
209-
210-
When a captcha was solved wrong by our workers, you can notify the server with it's ID,
211-
so we know something went wrong.
212-
213-
``` python
214-
ita.set_captcha_bad(captcha_id)
215-
```
216-
217-
## Examples
218-
Check root folder for examples, for each type of captcha.
219-
220-
## License
221-
API library is licensed under the MIT License
222-
223-
## More information
224-
More details about the server-side API can be found [here](http://imagetyperz.com)
9+
From now on use the library for python3, which includes our latest updates (including reCAPTCHA enterprise) and can be found here: [imagetyperz-api-python3](https://github.com/imagetyperz-api/imagetyperz-api-python3)
22510

22611

22712
<sup><sub>captcha, bypasscaptcha, decaptcher, decaptcha, 2captcha, deathbycaptcha, anticaptcha,

0 commit comments

Comments
 (0)