Residential Proxy Probe
Try for free
No credit card required
Go to Store
Residential Proxy Probe
jancurn/residential-proxy-probe
Try for free
No credit card required
Find residential proxy sessions on Apify Proxy with target IP addresses geo-located in specific postal codes or DMAs.
Developer
Jan ČurnMaintained by Community
Actor Metrics
10 monthly users
No reviews yet
5 bookmarks
0% runs succeeded
Created in Sep 2019
Modified 4 years ago
Categories
You can access the Residential Proxy Probe programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "1EfVgyATxnjLenSIp"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/jancurn~residential-proxy-probe/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-jancurn-residential-proxy-probe",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/jancurn~residential-proxy-probe/runs": {
50 "post": {
51 "operationId": "runs-sync-jancurn-residential-proxy-probe",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/jancurn~residential-proxy-probe/run-sync": {
93 "post": {
94 "operationId": "run-sync-jancurn-residential-proxy-probe",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "required": [
134 "countryCode",
135 "recordKey"
136 ],
137 "properties": {
138 "countryCode": {
139 "title": "Country",
140 "enum": [
141 "",
142 "af",
143 "al",
144 "dz",
145 "as",
146 "ad",
147 "ao",
148 "ai",
149 "aq",
150 "ag",
151 "ar",
152 "am",
153 "aw",
154 "au",
155 "at",
156 "az",
157 "bs",
158 "bh",
159 "bd",
160 "bb",
161 "by",
162 "be",
163 "bz",
164 "bj",
165 "bm",
166 "bt",
167 "bo",
168 "ba",
169 "bw",
170 "bv",
171 "br",
172 "io",
173 "bn",
174 "bg",
175 "bf",
176 "bi",
177 "kh",
178 "cm",
179 "ca",
180 "cv",
181 "ky",
182 "cf",
183 "td",
184 "cl",
185 "cn",
186 "cx",
187 "cc",
188 "co",
189 "km",
190 "cg",
191 "cd",
192 "ck",
193 "cr",
194 "ci",
195 "hr",
196 "cu",
197 "cy",
198 "cz",
199 "dk",
200 "dj",
201 "dm",
202 "do",
203 "ec",
204 "eg",
205 "sv",
206 "gq",
207 "er",
208 "ee",
209 "et",
210 "fk",
211 "fo",
212 "fj",
213 "fi",
214 "fr",
215 "gf",
216 "pf",
217 "tf",
218 "ga",
219 "gm",
220 "ge",
221 "de",
222 "gh",
223 "gi",
224 "gr",
225 "gl",
226 "gd",
227 "gp",
228 "gu",
229 "gt",
230 "gn",
231 "gw",
232 "gy",
233 "ht",
234 "hm",
235 "va",
236 "hn",
237 "hk",
238 "hu",
239 "is",
240 "in",
241 "id",
242 "ir",
243 "iq",
244 "ie",
245 "il",
246 "it",
247 "jm",
248 "jp",
249 "jo",
250 "kz",
251 "ke",
252 "ki",
253 "kp",
254 "kr",
255 "kw",
256 "kg",
257 "la",
258 "lv",
259 "lb",
260 "ls",
261 "lr",
262 "ly",
263 "li",
264 "lt",
265 "lu",
266 "mo",
267 "mk",
268 "mg",
269 "mw",
270 "my",
271 "mv",
272 "ml",
273 "mt",
274 "mh",
275 "mq",
276 "mr",
277 "mu",
278 "yt",
279 "mx",
280 "fm",
281 "md",
282 "mc",
283 "mn",
284 "ms",
285 "ma",
286 "mz",
287 "mm",
288 "na",
289 "nr",
290 "np",
291 "nl",
292 "an",
293 "nc",
294 "nz",
295 "ni",
296 "ne",
297 "ng",
298 "nu",
299 "nf",
300 "mp",
301 "no",
302 "om",
303 "pk",
304 "pw",
305 "ps",
306 "pa",
307 "pg",
308 "py",
309 "pe",
310 "ph",
311 "pn",
312 "pl",
313 "pt",
314 "pr",
315 "qa",
316 "re",
317 "ro",
318 "ru",
319 "rw",
320 "sh",
321 "kn",
322 "lc",
323 "pm",
324 "vc",
325 "ws",
326 "sm",
327 "st",
328 "sa",
329 "sn",
330 "cs",
331 "sc",
332 "sl",
333 "sg",
334 "sk",
335 "si",
336 "sb",
337 "so",
338 "za",
339 "gs",
340 "es",
341 "lk",
342 "sd",
343 "sr",
344 "sj",
345 "sz",
346 "se",
347 "ch",
348 "sy",
349 "tw",
350 "tj",
351 "tz",
352 "th",
353 "tl",
354 "tg",
355 "tk",
356 "to",
357 "tt",
358 "tn",
359 "tr",
360 "tm",
361 "tc",
362 "tv",
363 "ug",
364 "ua",
365 "ae",
366 "uk",
367 "us",
368 "um",
369 "uy",
370 "uz",
371 "vu",
372 "ve",
373 "vn",
374 "vg",
375 "vi",
376 "wf",
377 "eh",
378 "ye",
379 "zm",
380 "zw"
381 ],
382 "type": "string",
383 "description": "Country for the residential proxies. The values must be lower-cased <a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\" target=\"_blank\">ISO 3166</a> country codes supported by Apify Proxy."
384 },
385 "postalCodes": {
386 "title": "Postal codes",
387 "type": "string",
388 "description": "A whitespace-separated list of postal codes from which you need residential proxies. It cannot be used together with <b>DMA codes</b>."
389 },
390 "dmaCodes": {
391 "title": "DMA codes",
392 "type": "string",
393 "description": "A whitespace-separated list of Designated Market Area (DMA) codes as defined by Nielsen from which you need residential proxies. It cannot be used together with <b>Postal codes</b>."
394 },
395 "minSessionsPerRegion": {
396 "title": "Min sessions per region",
397 "minimum": 1,
398 "maximum": 100,
399 "type": "integer",
400 "description": "Minimum number of residential proxy sessions to maintain and keep alive for a single postal code or DMA (whichever is specified). The higher the value, the more residential proxy traffic the actor will consume!",
401 "default": 2
402 },
403 "maxSessionsPerRegion": {
404 "title": "Max sessions per region",
405 "minimum": 1,
406 "maximum": 100,
407 "type": "integer",
408 "description": "Maximum number of residential proxy sessions to maintain and keep alive for a single postal code or DMA (whichever is specified). The higher the value, the more residential proxy traffic the actor will consume!",
409 "default": 5
410 },
411 "newSessionsPerHeartbeat": {
412 "title": "New sessions per heartbeat",
413 "minimum": 1,
414 "maximum": 100,
415 "type": "integer",
416 "description": "If there are not enough session per region to meet the <b>minSessionsPerRegion</b> criteria, we're adding new session in every heartbeat (i.e. every 20 seconds). The higher the value, the more residential proxy traffic the actor will consume, but the faster it will find enough matching sessions.",
417 "default": 20
418 },
419 "keyValueStoreName": {
420 "title": "Key-value store name",
421 "type": "string",
422 "description": "Name of the Key-value store where to store the JSON file with the state. If empty, the actor stores data to the default key-value store associated with the actor run."
423 },
424 "recordKey": {
425 "title": "Key-value record name",
426 "type": "string",
427 "description": "The name of the record in the key-value store where the JSON file with the state is stored.",
428 "default": "RESIDENTIAL_PROXY_SESSION_POOL"
429 }
430 }
431 },
432 "runsResponseSchema": {
433 "type": "object",
434 "properties": {
435 "data": {
436 "type": "object",
437 "properties": {
438 "id": {
439 "type": "string"
440 },
441 "actId": {
442 "type": "string"
443 },
444 "userId": {
445 "type": "string"
446 },
447 "startedAt": {
448 "type": "string",
449 "format": "date-time",
450 "example": "2025-01-08T00:00:00.000Z"
451 },
452 "finishedAt": {
453 "type": "string",
454 "format": "date-time",
455 "example": "2025-01-08T00:00:00.000Z"
456 },
457 "status": {
458 "type": "string",
459 "example": "READY"
460 },
461 "meta": {
462 "type": "object",
463 "properties": {
464 "origin": {
465 "type": "string",
466 "example": "API"
467 },
468 "userAgent": {
469 "type": "string"
470 }
471 }
472 },
473 "stats": {
474 "type": "object",
475 "properties": {
476 "inputBodyLen": {
477 "type": "integer",
478 "example": 2000
479 },
480 "rebootCount": {
481 "type": "integer",
482 "example": 0
483 },
484 "restartCount": {
485 "type": "integer",
486 "example": 0
487 },
488 "resurrectCount": {
489 "type": "integer",
490 "example": 0
491 },
492 "computeUnits": {
493 "type": "integer",
494 "example": 0
495 }
496 }
497 },
498 "options": {
499 "type": "object",
500 "properties": {
501 "build": {
502 "type": "string",
503 "example": "latest"
504 },
505 "timeoutSecs": {
506 "type": "integer",
507 "example": 300
508 },
509 "memoryMbytes": {
510 "type": "integer",
511 "example": 1024
512 },
513 "diskMbytes": {
514 "type": "integer",
515 "example": 2048
516 }
517 }
518 },
519 "buildId": {
520 "type": "string"
521 },
522 "defaultKeyValueStoreId": {
523 "type": "string"
524 },
525 "defaultDatasetId": {
526 "type": "string"
527 },
528 "defaultRequestQueueId": {
529 "type": "string"
530 },
531 "buildNumber": {
532 "type": "string",
533 "example": "1.0.0"
534 },
535 "containerUrl": {
536 "type": "string"
537 },
538 "usage": {
539 "type": "object",
540 "properties": {
541 "ACTOR_COMPUTE_UNITS": {
542 "type": "integer",
543 "example": 0
544 },
545 "DATASET_READS": {
546 "type": "integer",
547 "example": 0
548 },
549 "DATASET_WRITES": {
550 "type": "integer",
551 "example": 0
552 },
553 "KEY_VALUE_STORE_READS": {
554 "type": "integer",
555 "example": 0
556 },
557 "KEY_VALUE_STORE_WRITES": {
558 "type": "integer",
559 "example": 1
560 },
561 "KEY_VALUE_STORE_LISTS": {
562 "type": "integer",
563 "example": 0
564 },
565 "REQUEST_QUEUE_READS": {
566 "type": "integer",
567 "example": 0
568 },
569 "REQUEST_QUEUE_WRITES": {
570 "type": "integer",
571 "example": 0
572 },
573 "DATA_TRANSFER_INTERNAL_GBYTES": {
574 "type": "integer",
575 "example": 0
576 },
577 "DATA_TRANSFER_EXTERNAL_GBYTES": {
578 "type": "integer",
579 "example": 0
580 },
581 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
582 "type": "integer",
583 "example": 0
584 },
585 "PROXY_SERPS": {
586 "type": "integer",
587 "example": 0
588 }
589 }
590 },
591 "usageTotalUsd": {
592 "type": "number",
593 "example": 0.00005
594 },
595 "usageUsd": {
596 "type": "object",
597 "properties": {
598 "ACTOR_COMPUTE_UNITS": {
599 "type": "integer",
600 "example": 0
601 },
602 "DATASET_READS": {
603 "type": "integer",
604 "example": 0
605 },
606 "DATASET_WRITES": {
607 "type": "integer",
608 "example": 0
609 },
610 "KEY_VALUE_STORE_READS": {
611 "type": "integer",
612 "example": 0
613 },
614 "KEY_VALUE_STORE_WRITES": {
615 "type": "number",
616 "example": 0.00005
617 },
618 "KEY_VALUE_STORE_LISTS": {
619 "type": "integer",
620 "example": 0
621 },
622 "REQUEST_QUEUE_READS": {
623 "type": "integer",
624 "example": 0
625 },
626 "REQUEST_QUEUE_WRITES": {
627 "type": "integer",
628 "example": 0
629 },
630 "DATA_TRANSFER_INTERNAL_GBYTES": {
631 "type": "integer",
632 "example": 0
633 },
634 "DATA_TRANSFER_EXTERNAL_GBYTES": {
635 "type": "integer",
636 "example": 0
637 },
638 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
639 "type": "integer",
640 "example": 0
641 },
642 "PROXY_SERPS": {
643 "type": "integer",
644 "example": 0
645 }
646 }
647 }
648 }
649 }
650 }
651 }
652 }
653 }
654}Residential Proxy Probe OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Residential Proxy Probe from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
