Skip to content

Commit fc77eba

Browse files
poplers24kratzky
andauthored
RC-2749-add-links-to-documentation (#93)
* - Added links to API documentation to methods in README.md Signed-off-by: Maxim S <poplers24@gmail.com> * - Links are wrapped in sup tag Signed-off-by: Maxim S <poplers24@gmail.com> --------- Signed-off-by: Maxim S <poplers24@gmail.com> Co-authored-by: Victor <kratzky@gmail.com>
1 parent c536a88 commit fc77eba

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ When you submit any image-based captcha use can provide additional options to he
103103
Below you can find basic examples for every captcha type. Check out [examples directory] to find more examples with all available options.
104104

105105
### Normal Captcha
106+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_normal_captcha)</sup>
107+
106108
To bypass a normal captcha (distorted text on an image) use the following method. This method also can be used to recognize any text on the image.
107109
```python
108110
result = solver.normal('path/to/captcha.jpg', param1=..., ...)
@@ -111,6 +113,9 @@ result = solver.normal('https://site-with-captcha.com/path/to/captcha.jpg', para
111113
```
112114

113115
### Audio Captcha
116+
117+
<sup>[API method description.](https://2captcha.com/2captcha-api#audio)</sup>
118+
114119
To bypass an audio captcha (mp3 formats only) use the following method.
115120
You must provide the language as `lang = 'en'`. Supported languages are "en", "ru", "de", "el", "pt", "fr".
116121

@@ -121,12 +126,18 @@ result = solver.audio('https://site-with-captcha.com/path/to/captcha.mp3', lang
121126
```
122127

123128
### Text Captcha
129+
130+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_text_captcha)</sup>
131+
124132
This method can be used to bypass a captcha that requires answering a question provided in clear text.
125133
```python
126134
result = solver.text('If tomorrow is Saturday, what day is today?', param1=..., ...)
127135
```
128136

129137
### reCAPTCHA v2
138+
139+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_recaptchav2_new)</sup>
140+
130141
Use this method to solve reCAPTCHA V2 and obtain a token to bypass the protection.
131142
```python
132143
result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
@@ -135,6 +146,9 @@ result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
135146
```
136147

137148
### reCAPTCHA v3
149+
150+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_recaptchav3)</sup>
151+
138152
This method provides a reCAPTCHA V3 solver and returns a token.
139153
```python
140154
result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
@@ -144,6 +158,9 @@ result = solver.recaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
144158
```
145159

146160
### FunCaptcha
161+
162+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_funcaptcha_new)</sup>
163+
147164
FunCaptcha (Arkoselabs) solving method. Returns a token.
148165
```python
149166
result = solver.funcaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
@@ -154,6 +171,9 @@ result = solver.funcaptcha(sitekey='6Le-wvkSVVABCPBMRTvw0Q4Muexq1bi0DJwx_mJ-',
154171

155172

156173
### GeeTest
174+
175+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_geetest)</sup>
176+
157177
Method to solve GeeTest puzzle captcha. Returns a set of tokens as JSON.
158178
```python
159179
result = solver.geetest(gt='f1ab2cdefa3456789012345b6c78d90e',
@@ -165,6 +185,9 @@ result = solver.geetest(gt='f1ab2cdefa3456789012345b6c78d90e',
165185

166186

167187
### GeeTest v4
188+
189+
<sup>[API method description.](https://2captcha.com/2captcha-api#geetest-v4)</sup>
190+
168191
Use this method to solve GeeTest v4. Returns the response in JSON.
169192
```python
170193
result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',
@@ -175,6 +198,9 @@ result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',
175198

176199

177200
### hCaptcha
201+
202+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_hcaptcha)</sup>
203+
178204
Use this method to solve the hCaptcha challenge. Returns a token to bypass the captcha.
179205
```python
180206
result = solver.hcaptcha(sitekey='10000000-ffff-ffff-ffff-000000000001',
@@ -185,6 +211,9 @@ result = solver.hcaptcha(sitekey='10000000-ffff-ffff-ffff-000000000001',
185211

186212

187213
### Lemin Cropped Captcha
214+
215+
<sup>[API method description.](https://2captcha.com/2captcha-api#lemin)</sup>
216+
188217
Use this method to solve hCaptcha challenge. Returns JSON with an answer containing the following values: answer, challenge_id.
189218
```python
190219
result = solver.lemin(captcha_id='CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
@@ -196,6 +225,9 @@ result = solver.lemin(captcha_id='CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d90
196225

197226

198227
### Cloudflare Turnstile
228+
229+
<sup>[API method description.](https://2captcha.com/2captcha-api#turnstile)</sup>
230+
199231
Use this method to solve Cloudflare Turnstile. Returns JSON with the token.
200232
```python
201233
result = solver.turnstile(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
@@ -207,6 +239,9 @@ result = solver.turnstile(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
207239
```
208240

209241
### Amazon WAF
242+
243+
<sup>[API method description.](https://2captcha.com/2captcha-api#amazon-waf)</sup>
244+
210245
Use this method to solve Amazon WAF Captcha also known as AWS WAF Captcha is a part of Intelligent threat mitigation for Amazon AWS. Returns JSON with the token.
211246
```python
212247
result = solver.amazon_waf(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
@@ -219,6 +254,9 @@ result = solver.amazon_waf(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
219254

220255

221256
### KeyCaptcha
257+
258+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_keycaptcha)</sup>
259+
222260
Token-based method to solve KeyCaptcha.
223261
```python
224262
result = solver.keycaptcha(s_s_c_user_id=10,
@@ -232,6 +270,9 @@ result = solver.keycaptcha(s_s_c_user_id=10,
232270

233271

234272
### atbCAPTCHA
273+
274+
<sup>[API method description.](https://2captcha.com/2captcha-api#atb-captcha)</sup>
275+
235276
Use this method to solve atbCaptcha challenge. Returns a token to bypass the captcha.
236277
```python
237278
result = solver.atb_captcha(app_id='af25e409b33d722a95e56a230ff8771c',
@@ -243,6 +284,9 @@ result = solver.atb_captcha(app_id='af25e409b33d722a95e56a230ff8771c',
243284

244285

245286
### Capy
287+
288+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_capy)</sup>
289+
246290
Token-based method to bypass Capy puzzle captcha.
247291
```python
248292
result = solver.capy(sitekey='PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v',
@@ -251,30 +295,45 @@ result = solver.capy(sitekey='PUZZLE_Abc1dEFghIJKLM2no34P56q7rStu8v',
251295
param1=..., ...)
252296
```
253297
### Grid
298+
299+
<sup>[API method description.](https://2captcha.com/2captcha-api#grid)</sup>
300+
254301
Grid method was originally called the Old reCAPTCHA V2 method. The method can be used to bypass any type of captcha where you can apply a grid on an image and click specific grid boxes. Returns numbers of boxes.
255302
```python
256303
result = solver.grid('path/to/captcha.jpg', param1=..., ...)
257304
```
258305

259306
### Canvas
307+
308+
<sup>[API method description.](https://2captcha.com/2captcha-api#canvas)</sup>
309+
260310
Canvas method can be used when you need to draw a line around an object on an image. Returns a set of points' coordinates to draw a polygon.
261311
```python
262312
result = solver.canvas('path/to/captcha.jpg', param1=..., ...)
263313
```
264314

265315
### ClickCaptcha
316+
317+
<sup>[API method description.](https://2captcha.com/2captcha-api#coordinates)</sup>
318+
266319
ClickCaptcha method returns coordinates of points on the captcha image. Can be used if you need to click on particular points in the image.
267320
```python
268321
result = solver.coordinates('path/to/captcha.jpg', param1=..., ...)
269322
```
270323

271324
### Rotate
325+
326+
<sup>[API method description.](https://2captcha.com/2captcha-api#solving_rotatecaptcha)</sup>
327+
272328
This method can be used to solve a captcha that asks to rotate an object. Mostly used to bypass FunCaptcha. Returns the rotation angle.
273329
```python
274330
result = solver.rotate('path/to/captcha.jpg', param1=..., ...)
275331
```
276332

277333
### MTCaptcha
334+
335+
<sup>[API method description.](https://2captcha.com/2captcha-api#mtcaptcha)</sup>
336+
278337
Use this method to solve MTCaptcha and obtain a token to bypass the protection.
279338
```python
280339
result = solver.mtcaptcha(sitekey='MTPublic-KzqLY1cKH',
@@ -283,6 +342,9 @@ result = solver.mtcaptcha(sitekey='MTPublic-KzqLY1cKH',
283342
```
284343

285344
### Friendly Captcha
345+
346+
<sup>[API method description.](https://2captcha.com/2captcha-api#friendly-captcha)</sup>
347+
286348
Friendly Captcha solving method. Returns a token.
287349
```python
288350
result = solver.friendly_captcha(sitekey='FCMGEMUD2KTDSQ5H',
@@ -291,6 +353,9 @@ result = solver.friendly_captcha(sitekey='FCMGEMUD2KTDSQ5H',
291353
```
292354

293355
### Cutcaptcha
356+
357+
<sup>[API method description.](https://2captcha.com/2captcha-api#cutcaptcha)</sup>
358+
294359
Use this method to solve Cutcaptcha. Returns the response in JSON.
295360
```python
296361
result = solver.cutcaptcha(misery_key='ad52c87af17e2ec09b8d918c9f00416b1cb8c320',
@@ -300,6 +365,9 @@ result = solver.cutcaptcha(misery_key='ad52c87af17e2ec09b8d918c9f00416b1cb8c320'
300365
```
301366

302367
### Tencent
368+
369+
<sup>[API method description.](https://2captcha.com/2captcha-api#tencent)</sup>
370+
303371
Use this method to solve Cutcaptcha. Returns a token.
304372
```python
305373
result = solver.tencent(app_id="197326679",

0 commit comments

Comments
 (0)