# get proxy list for ip whitelist auth

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/proxy/get_proxy_list:
    get:
      summary: get proxy list for ip whitelist auth
      deprecated: false
      description: return proxy list for ip whitelist access auth, json or txt format
      tags:
        - Rotation proxy/api proxy list
        - api proxy list
      parameters:
        - name: token
          in: query
          description: user token
          required: true
          example: ''
          schema:
            type: string
        - name: num
          in: query
          description: gen proxy quantity
          required: true
          example: 0
          schema:
            type: integer
        - name: type
          in: query
          description: datacenter or residential
          required: true
          example: ''
          schema:
            type: string
        - name: location
          in: query
          description: node location
          required: false
          example: ''
          schema:
            type: string
        - name: region
          in: query
          description: node region
          required: false
          example: ''
          schema:
            type: string
        - name: city
          in: query
          description: node city
          required: false
          example: ''
          schema:
            type: string
        - name: isp
          in: query
          description: node isp
          required: false
          example: ''
          schema:
            type: string
        - name: return_type
          in: query
          description: json or txt
          required: true
          example: ''
          schema:
            type: string
        - name: lb
          in: query
          description: >-
            separator 1:\r\n 2:/br 3:\r 4:\n 5:\t, required when return_type is
            txt
          required: false
          example: 0
          schema:
            type: integer
        - name: Authorization
          in: header
          description: ''
          example: Bearer {{AUTH_TOKEN}}
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta_message:
                    type: string
                    description: success or other error msg
                  meta_status:
                    type: integer
                    description: 1 for success, negative for error
                  proxy:
                    type: array
                    items:
                      type: object
                      properties:
                        address:
                          type: string
                          description: proxy address
                        port:
                          type: integer
                          description: proxy port
                      x-apifox-refs: {}
                      x-apifox-orders:
                        - address
                        - port
                    description: proxy info
                x-apifox-refs: {}
                x-apifox-orders:
                  - meta_message
                  - meta_status
                  - proxy
          headers: {}
          x-apifox-name: result
        x-200:result:
          description: ''
          content:
            '*/*':
              schema:
                type: object
                properties: {}
          headers: {}
          x-apifox-name: result
      security: []
      x-apifox-folder: Rotation proxy/api proxy list
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/2880121/apis/api-88999363-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.ipcola.com
    description: ipcola
security: []

```