[{"data":1,"prerenderedAt":1050},["ShallowReactive",2],{"doc-en-openapi":3},{"id":4,"title":5,"body":6,"description":1042,"extension":1043,"faq":1044,"meta":1045,"navigation":989,"path":1046,"seo":1047,"stem":1048,"__hash__":1049},"docs\u002Fdocs\u002Fen\u002Fopenapi.md","🔌 OpenAPI",{"type":7,"value":8,"toc":1030},"minimark",[9,19,33,38,109,113,120,123,128,358,363,401,418,423,445,515,521,524,528,531,535,590,594,606,653,659,662,666,729,733,736,740,752,758,761,765,826,830,832,836,848,854,857,861,907,911,948,952,964,968,1003,1007,1010,1018,1026],[10,11,12,13,18],"p",{},"EProxies exposes 5 HTTP endpoints (whitelist-mode proxy extraction and whitelist management). This page is a quick reference; for detailed usage see ",[14,15,17],"a",{"href":16},"\u002Fdocs\u002Fusage\u002Fapi-extraction","API Extraction (Whitelist Mode)",".",[20,21,23],"hint",{"type":22},"info",[10,24,25,26,32],{},"Machine-readable definition: ",[14,27,31],{"href":28,"rel":29},"https:\u002F\u002Fwww.eproxies.io\u002Fdocs\u002Fopenapi.json",[30],"nofollow","openapi.json"," — an OpenAPI 3.0 spec you can import straight into Postman \u002F Swagger UI \u002F Insomnia, or hand to an AI agent to call automatically.",[34,35,37],"h2",{"id":36},"basics","Basics",[39,40,41,54],"table",{},[42,43,44],"thead",{},[45,46,47,51],"tr",{},[48,49,50],"th",{},"Item",[48,52,53],{},"Value",[55,56,57,69,82,98],"tbody",{},[45,58,59,63],{},[60,61,62],"td",{},"Base URL",[60,64,65],{},[66,67,68],"code",{},"https:\u002F\u002Fapi.eproxies.net",[45,70,71,74],{},[60,72,73],{},"Auth (extraction)",[60,75,76,77,81],{},"Request must originate from a ",[78,79,80],"strong",{},"whitelisted IP","; no credentials needed",[45,83,84,87],{},[60,85,86],{},"Auth (management)",[60,88,89,90,93,94,97],{},"Query params ",[66,91,92],{},"userName"," + ",[66,95,96],{},"userKeyValue"," (user key, from the dashboard)",[45,99,100,103],{},[60,101,102],{},"Proxy gateway",[60,104,105,108],{},[66,106,107],{},"proxy.eproxies.net:23333"," (HTTP\u002FHTTPS\u002FSOCKS5 — not part of this HTTP API)",[34,110,112],{"id":111},"endpoints","Endpoints",[114,115,117],"h3",{"id":116},"get-gateway_apiextract_ip",[66,118,119],{},"GET \u002Fgateway_api\u002Fextract_ip",[10,121,122],{},"Extract proxies — Extract a batch of proxy endpoints. The request must originate from a whitelisted IP; the returned proxies are used directly, without credentials.",[10,124,125],{},[78,126,127],{},"Request parameters",[39,129,130,149],{},[42,131,132],{},[45,133,134,137,140,143,146],{},[48,135,136],{},"Field",[48,138,139],{},"Type",[48,141,142],{},"Required",[48,144,145],{},"Allowed values",[48,147,148],{},"Description",[55,150,151,173,208,231,259,310,330],{},[45,152,153,158,161,164,170],{},[60,154,155],{},[66,156,157],{},"count",[60,159,160],{},"integer",[60,162,163],{},"Yes",[60,165,166,169],{},[66,167,168],{},"1"," ~ N",[60,171,172],{},"Number of proxies to extract",[45,174,175,180,183,186,202],{},[60,176,177],{},[66,178,179],{},"country",[60,181,182],{},"string",[60,184,185],{},"No",[60,187,188,191,192,191,195,198,199],{},[66,189,190],{},"US"," ",[66,193,194],{},"GB",[66,196,197],{},"JP"," … \u002F ",[66,200,201],{},"Global",[60,203,204,205,207],{},"ISO 3166-1 alpha-2 country code; ",[66,206,201],{}," means any country",[45,209,210,215,217,219,228],{},[60,211,212],{},[66,213,214],{},"protocol",[60,216,182],{},[60,218,185],{},[60,220,221,224,225],{},[66,222,223],{},"http"," \u002F ",[66,226,227],{},"socks5",[60,229,230],{},"Proxy protocol",[45,232,233,238,240,242,250],{},[60,234,235],{},[66,236,237],{},"format",[60,239,182],{},[60,241,185],{},[60,243,244,224,247],{},[66,245,246],{},"txt",[66,248,249],{},"json",[60,251,252,253,255,256,258],{},"Response format; ",[66,254,249],{}," returns an object array, ",[66,257,246],{}," returns plain-text lines",[45,260,261,266,268,270,287],{},[60,262,263],{},[66,264,265],{},"separator",[60,267,182],{},[60,269,185],{},[60,271,272,191,275,191,278,191,281,191,284],{},[66,273,274],{},"crlf",[66,276,277],{},"br",[66,279,280],{},"cr",[66,282,283],{},"lf",[66,285,286],{},"tab",[60,288,289,290,292,293,296,297,296,300,296,303,296,306,309],{},"Separator for ",[66,291,246],{}," format: ",[66,294,295],{},"\\r\\n",", ",[66,298,299],{},"\u003C\u002Fbr>",[66,301,302],{},"\\r",[66,304,305],{},"\\n",[66,307,308],{},"\\t"," respectively",[45,311,312,317,319,321,324],{},[60,313,314],{},[66,315,316],{},"st",[60,318,182],{},[60,320,185],{},[60,322,323],{},"—",[60,325,326,327,329],{},"Custom separator; overrides ",[66,328,265],{}," when set",[45,331,332,337,339,341,349],{},[60,333,334],{},[66,335,336],{},"session",[60,338,182],{},[60,340,185],{},[60,342,343,224,346],{},[66,344,345],{},"sticky",[66,347,348],{},"random",[60,350,351,352,354,355,357],{},"IP type: ",[66,353,345],{}," reuses the same batch of IPs, ",[66,356,348],{}," returns random ones",[10,359,360],{},[78,361,362],{},"Response fields",[39,364,365,375],{},[42,366,367],{},[45,368,369,371,373],{},[48,370,136],{},[48,372,139],{},[48,374,148],{},[55,376,377,389],{},[45,378,379,384,386],{},[60,380,381],{},[66,382,383],{},"ipAddress",[60,385,182],{},[60,387,388],{},"Proxy IP address",[45,390,391,396,398],{},[60,392,393],{},[66,394,395],{},"portValue",[60,397,160],{},[60,399,400],{},"Proxy port",[10,402,403,404,407,408,411,412,415,416,18],{},"With ",[66,405,406],{},"format=json"," the response is an array of the objects above; with ",[66,409,410],{},"format=txt"," it is ",[66,413,414],{},"IP:port"," text lines joined by ",[66,417,265],{},[10,419,420],{},[78,421,422],{},"Example",[424,425,430],"pre",{"className":426,"code":427,"language":428,"meta":429,"style":429},"language-bash shiki shiki-themes github-light","curl \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fextract_ip?count=10&country=US&protocol=http&format=json&session=sticky\"\n","bash","",[66,431,432],{"__ignoreMap":429},[433,434,437,441],"span",{"class":435,"line":436},"line",1,[433,438,440],{"class":439},"s7eDp","curl",[433,442,444],{"class":443},"sYBdl"," \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fextract_ip?count=10&country=US&protocol=http&format=json&session=sticky\"\n",[424,446,449],{"className":447,"code":448,"language":249,"meta":429,"style":429},"language-json shiki shiki-themes github-light","[\n  { \"ipAddress\": \"203.0.113.10\", \"portValue\": 23333 },\n  { \"ipAddress\": \"203.0.113.11\", \"portValue\": 23333 }\n]\n",[66,450,451,457,486,509],{"__ignoreMap":429},[433,452,453],{"class":435,"line":436},[433,454,456],{"class":455},"sgsFI","[\n",[433,458,460,463,467,470,473,475,478,480,483],{"class":435,"line":459},2,[433,461,462],{"class":455},"  { ",[433,464,466],{"class":465},"sYu0t","\"ipAddress\"",[433,468,469],{"class":455},": ",[433,471,472],{"class":443},"\"203.0.113.10\"",[433,474,296],{"class":455},[433,476,477],{"class":465},"\"portValue\"",[433,479,469],{"class":455},[433,481,482],{"class":465},"23333",[433,484,485],{"class":455}," },\n",[433,487,489,491,493,495,498,500,502,504,506],{"class":435,"line":488},3,[433,490,462],{"class":455},[433,492,466],{"class":465},[433,494,469],{"class":455},[433,496,497],{"class":443},"\"203.0.113.11\"",[433,499,296],{"class":455},[433,501,477],{"class":465},[433,503,469],{"class":455},[433,505,482],{"class":465},[433,507,508],{"class":455}," }\n",[433,510,512],{"class":435,"line":511},4,[433,513,514],{"class":455},"]\n",[114,516,518],{"id":517},"get-gateway_apicountry-list",[66,519,520],{},"GET \u002Fgateway_api\u002Fcountry-list",[10,522,523],{},"Supported countries — List every country available for whitelist-mode extraction.",[10,525,526],{},[78,527,127],{},[10,529,530],{},"No request parameters.",[10,532,533],{},[78,534,362],{},[39,536,537,547],{},[42,538,539],{},[45,540,541,543,545],{},[48,542,136],{},[48,544,139],{},[48,546,148],{},[55,548,549,566,578],{},[45,550,551,555,557],{},[60,552,553],{},[66,554,179],{},[60,556,182],{},[60,558,559,560,562,563],{},"ISO 3166-1 alpha-2 code — use it as the ",[66,561,179],{}," parameter of ",[66,564,565],{},"extract_ip",[45,567,568,573,575],{},[60,569,570],{},[66,571,572],{},"name",[60,574,182],{},[60,576,577],{},"Country name",[45,579,580,585,587],{},[60,581,582],{},[66,583,584],{},"flag_url",[60,586,182],{},[60,588,589],{},"Flag icon URL",[10,591,592],{},[78,593,422],{},[424,595,597],{"className":426,"code":596,"language":428,"meta":429,"style":429},"curl \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fcountry-list\"\n",[66,598,599],{"__ignoreMap":429},[433,600,601,603],{"class":435,"line":436},[433,602,440],{"class":439},[433,604,605],{"class":443}," \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fcountry-list\"\n",[424,607,609],{"className":447,"code":608,"language":249,"meta":429,"style":429},"[\n  { \"country\": \"US\", \"name\": \"United States\", \"flag_url\": \"https:\u002F\u002Ffile.eproxies.net\u002Fflags\u002Fus.png\" }\n]\n",[66,610,611,615,649],{"__ignoreMap":429},[433,612,613],{"class":435,"line":436},[433,614,456],{"class":455},[433,616,617,619,622,624,627,629,632,634,637,639,642,644,647],{"class":435,"line":459},[433,618,462],{"class":455},[433,620,621],{"class":465},"\"country\"",[433,623,469],{"class":455},[433,625,626],{"class":443},"\"US\"",[433,628,296],{"class":455},[433,630,631],{"class":465},"\"name\"",[433,633,469],{"class":455},[433,635,636],{"class":443},"\"United States\"",[433,638,296],{"class":455},[433,640,641],{"class":465},"\"flag_url\"",[433,643,469],{"class":455},[433,645,646],{"class":443},"\"https:\u002F\u002Ffile.eproxies.net\u002Fflags\u002Fus.png\"",[433,648,508],{"class":455},[433,650,651],{"class":435,"line":488},[433,652,514],{"class":455},[114,654,656],{"id":655},"get-gateway_apiadd-ip",[66,657,658],{},"GET \u002Fgateway_api\u002Fadd-ip",[10,660,661],{},"Add a whitelist IP — Add an exit IP to the whitelist; that IP can then extract proxies without credentials.",[10,663,664],{},[78,665,127],{},[39,667,668,682],{},[42,669,670],{},[45,671,672,674,676,678,680],{},[48,673,136],{},[48,675,139],{},[48,677,142],{},[48,679,145],{},[48,681,148],{},[55,683,684,699,714],{},[45,685,686,690,692,694,696],{},[60,687,688],{},[66,689,92],{},[60,691,182],{},[60,693,163],{},[60,695,323],{},[60,697,698],{},"Account username",[45,700,701,705,707,709,711],{},[60,702,703],{},[66,704,96],{},[60,706,182],{},[60,708,163],{},[60,710,323],{},[60,712,713],{},"User key, from the dashboard",[45,715,716,720,722,724,726],{},[60,717,718],{},[66,719,383],{},[60,721,182],{},[60,723,163],{},[60,725,323],{},[60,727,728],{},"IP address to whitelist",[10,730,731],{},[78,732,362],{},[10,734,735],{},"Returns an operation-result object; refer to the actual response.",[10,737,738],{},[78,739,422],{},[424,741,743],{"className":426,"code":742,"language":428,"meta":429,"style":429},"curl \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fadd-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10\"\n",[66,744,745],{"__ignoreMap":429},[433,746,747,749],{"class":435,"line":436},[433,748,440],{"class":439},[433,750,751],{"class":443}," \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fadd-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10\"\n",[114,753,755],{"id":754},"get-gateway_apidel-ip",[66,756,757],{},"GET \u002Fgateway_api\u002Fdel-ip",[10,759,760],{},"Delete a whitelist IP — Remove an IP from the whitelist; it can no longer extract without credentials.",[10,762,763],{},[78,764,127],{},[39,766,767,781],{},[42,768,769],{},[45,770,771,773,775,777,779],{},[48,772,136],{},[48,774,139],{},[48,776,142],{},[48,778,145],{},[48,780,148],{},[55,782,783,797,811],{},[45,784,785,789,791,793,795],{},[60,786,787],{},[66,788,92],{},[60,790,182],{},[60,792,163],{},[60,794,323],{},[60,796,698],{},[45,798,799,803,805,807,809],{},[60,800,801],{},[66,802,96],{},[60,804,182],{},[60,806,163],{},[60,808,323],{},[60,810,713],{},[45,812,813,817,819,821,823],{},[60,814,815],{},[66,816,383],{},[60,818,182],{},[60,820,163],{},[60,822,323],{},[60,824,825],{},"Whitelist IP to remove",[10,827,828],{},[78,829,362],{},[10,831,735],{},[10,833,834],{},[78,835,422],{},[424,837,839],{"className":426,"code":838,"language":428,"meta":429,"style":429},"curl \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fdel-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10\"\n",[66,840,841],{"__ignoreMap":429},[433,842,843,845],{"class":435,"line":436},[433,844,440],{"class":439},[433,846,847],{"class":443}," \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fdel-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10\"\n",[114,849,851],{"id":850},"get-gateway_apilists-ip",[66,852,853],{},"GET \u002Fgateway_api\u002Flists-ip",[10,855,856],{},"List whitelist entries — List all whitelist entries under the current account.",[10,858,859],{},[78,860,127],{},[39,862,863,877],{},[42,864,865],{},[45,866,867,869,871,873,875],{},[48,868,136],{},[48,870,139],{},[48,872,142],{},[48,874,145],{},[48,876,148],{},[55,878,879,893],{},[45,880,881,885,887,889,891],{},[60,882,883],{},[66,884,92],{},[60,886,182],{},[60,888,163],{},[60,890,323],{},[60,892,698],{},[45,894,895,899,901,903,905],{},[60,896,897],{},[66,898,96],{},[60,900,182],{},[60,902,163],{},[60,904,323],{},[60,906,713],{},[10,908,909],{},[78,910,362],{},[39,912,913,923],{},[42,914,915],{},[45,916,917,919,921],{},[48,918,136],{},[48,920,139],{},[48,922,148],{},[55,924,925,936],{},[45,926,927,931,933],{},[60,928,929],{},[66,930,383],{},[60,932,182],{},[60,934,935],{},"Whitelisted IP",[45,937,938,943,945],{},[60,939,940],{},[66,941,942],{},"remarkText",[60,944,182],{},[60,946,947],{},"Remark",[10,949,950],{},[78,951,422],{},[424,953,955],{"className":426,"code":954,"language":428,"meta":429,"style":429},"curl \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Flists-ip?userName=USERNAME&userKeyValue=USER_KEY\"\n",[66,956,957],{"__ignoreMap":429},[433,958,959,961],{"class":435,"line":436},[433,960,440],{"class":439},[433,962,963],{"class":443}," \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Flists-ip?userName=USERNAME&userKeyValue=USER_KEY\"\n",[34,965,967],{"id":966},"quick-call","Quick call",[424,969,971],{"className":426,"code":970,"language":428,"meta":429,"style":429},"# Extract 10 US HTTP proxies (JSON, sticky IPs)\ncurl \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fextract_ip?count=10&country=US&protocol=http&format=json&session=sticky\"\n\n# Whitelist the current server IP\ncurl \"https:\u002F\u002Fapi.eproxies.net\u002Fgateway_api\u002Fadd-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10\"\n",[66,972,973,979,985,991,996],{"__ignoreMap":429},[433,974,975],{"class":435,"line":436},[433,976,978],{"class":977},"sAwPA","# Extract 10 US HTTP proxies (JSON, sticky IPs)\n",[433,980,981,983],{"class":435,"line":459},[433,982,440],{"class":439},[433,984,444],{"class":443},[433,986,987],{"class":435,"line":488},[433,988,990],{"emptyLinePlaceholder":989},true,"\n",[433,992,993],{"class":435,"line":511},[433,994,995],{"class":977},"# Whitelist the current server IP\n",[433,997,999,1001],{"class":435,"line":998},5,[433,1000,440],{"class":439},[433,1002,751],{"class":443},[34,1004,1006],{"id":1005},"using-it-from-an-ai-agent","Using it from an AI agent",[10,1008,1009],{},"Point your agent at the spec URL and it can work out every parameter and response shape on its own:",[424,1011,1016],{"className":1012,"code":1014,"language":1015},[1013],"language-text","https:\u002F\u002Fwww.eproxies.io\u002Fdocs\u002Fopenapi.json\n","text",[66,1017,1014],{"__ignoreMap":429},[10,1019,1020,1021,1025],{},"Together with the ",[14,1022,1024],{"href":1023},"\u002Fdocs\u002Fagent-reference","Agent Cheat Sheet"," (username parameter syntax for the proxy gateway) this covers the full integration surface.",[1027,1028,1029],"style",{},"html pre.shiki code .s7eDp, html code.shiki .s7eDp{--shiki-default:#6F42C1}html pre.shiki code .sYBdl, html code.shiki .sYBdl{--shiki-default:#032F62}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}html pre.shiki code .sgsFI, html code.shiki .sgsFI{--shiki-default:#24292E}html pre.shiki code .sYu0t, html code.shiki .sYu0t{--shiki-default:#005CC5}",{"title":429,"searchDepth":459,"depth":459,"links":1031},[1032,1033,1040,1041],{"id":36,"depth":459,"text":37},{"id":111,"depth":459,"text":112,"children":1034},[1035,1036,1037,1038,1039],{"id":116,"depth":488,"text":119},{"id":517,"depth":488,"text":520},{"id":655,"depth":488,"text":658},{"id":754,"depth":488,"text":757},{"id":850,"depth":488,"text":853},{"id":966,"depth":459,"text":967},{"id":1005,"depth":459,"text":1006},"Endpoint reference for the EProxies public HTTP API, plus the OpenAPI 3.0 spec for Postman, Swagger UI or AI agents.","md",null,{},"\u002Fdocs\u002Fen\u002Fopenapi",{"title":5,"description":1042},"docs\u002Fen\u002Fopenapi","AXNGd9_z3mlftoioq5FAGM8crUd4VpeXNsk_XdaZ41w",1785671055506]