# List Proxies

GET https://api.bctrl.ai/v1/proxies

Reference: https://platform.bctrl.ai/api/api-reference/proxies/list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/proxies:
    get:
      operationId: list
      summary: List saved proxies
      tags:
        - subpackage_proxies
      parameters:
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proxies_list_Response_200'
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0ConnectionProtocol:
      type: string
      enum:
        - http
        - socks5
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0ConnectionProtocol
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0Connection:
      type: object
      properties:
        hasPassword:
          type: boolean
        host:
          type: string
        port:
          type: integer
        protocol:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0ConnectionProtocol
        username:
          type:
            - string
            - 'null'
      required:
        - hasPassword
        - host
        - port
        - protocol
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0Connection
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0Kind:
      type: string
      enum:
        - custom
      title: V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0Kind
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems0:
      type: object
      properties:
        connection:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0Connection
        createdAt:
          type: string
        id:
          type: string
          format: uuid
        kind:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf0Kind
        name:
          type: string
        updatedAt:
          type: string
      required:
        - connection
        - createdAt
        - id
        - kind
        - name
        - updatedAt
      title: V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems0
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsGeo:
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        isp:
          type: string
        region:
          type: string
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsGeo
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsIpFamily:
      type: string
      enum:
        - dual-stack
        - ipv4-only
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsIpFamily
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsPoolPreference:
      type: string
      enum:
        - quality
        - quality-speed
        - speed
        - max-pool
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsPoolPreference
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsProtocol:
      type: string
      enum:
        - http
        - socks5
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsProtocol
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSessionOneOf0Strategy:
      type: string
      enum:
        - rotate
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSessionOneOf0Strategy
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession0:
      type: object
      properties:
        strategy:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSessionOneOf0Strategy
      required:
        - strategy
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession0
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSessionOneOf1Strategy:
      type: string
      enum:
        - sticky
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSessionOneOf1Strategy
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession1:
      type: object
      properties:
        key:
          type: string
        strategy:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSessionOneOf1Strategy
      required:
        - strategy
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession1
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession:
      oneOf:
        - $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession0
        - $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession1
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1Defaults:
      type: object
      properties:
        geo:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsGeo
        ipFamily:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsIpFamily
        poolPreference:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsPoolPreference
        protocol:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsProtocol
        session:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1DefaultsSession
      title: >-
        V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1Defaults
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1Kind:
      type: string
      enum:
        - managed-rotating
      title: V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1Kind
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems1:
      type: object
      properties:
        createdAt:
          type: string
        defaults:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1Defaults
        id:
          type: string
          format: uuid
        kind:
          $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItemsOneOf1Kind
        name:
          type: string
        updatedAt:
          type: string
      required:
        - createdAt
        - defaults
        - id
        - kind
        - name
        - updatedAt
      title: V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems1
    V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems:
      oneOf:
        - $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems0
        - $ref: >-
            #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems1
      title: V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems
    proxies_list_Response_200:
      type: object
      properties:
        proxies:
          type: array
          items:
            $ref: >-
              #/components/schemas/V1ProxiesGetResponsesContentApplicationJsonSchemaProxiesItems
        totalCount:
          type: integer
      required:
        - proxies
        - totalCount
      title: proxies_list_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/proxies"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/proxies';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/proxies"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bctrl.ai/v1/proxies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.bctrl.ai/v1/proxies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bctrl.ai/v1/proxies', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/proxies");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/proxies")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```