> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get credentials

> The gateway host, ports and login of your proxy access. The same login works for HTTP and SOCKS5.

Permission: `lines`



## OpenAPI

````yaml /api-reference/openapi.json get /api/dashboard/credentials
openapi: 3.1.0
info:
  title: Proxies.Vision API
  version: '1.0'
  description: >
    Everything the dashboard does for your residential proxies, from a script or
    an AI agent: check bandwidth, build proxy lists, buy GB and, for resellers,
    run sub-users.


    ## Authentication


    Send an API key as a bearer token: `Authorization: Bearer pv_…`. Create keys
    in [Dashboard → API keys](https://proxies.vision/dashboard/api-keys). Each
    key has its own permissions: `read`, `lines`, `buy` (with an optional daily
    limit) and, for resellers, `subusers`. A key can't sign in to the dashboard
    or change your account.


    ## Errors


    A failed request returns an HTTP status and `{"detail": "…"}`.


    | Code | Meaning |

    |---|---|

    | 400 | A combination that can't work, e.g. a network (ASN) without a
    country |

    | 401 | Missing, wrong or revoked key |

    | 402 | Balance or pool too low; the message says how much is there |

    | 403 | The key lacks the permission, its daily limit is reached, or the
    account isn't a reseller |

    | 422 | A parameter is missing or out of range |

    | 503 | Purchases are paused for a moment |


    ## MCP server


    AI agents connect to `https://proxies.vision/mcp` (Streamable HTTP) with the
    same key and get one tool per endpoint here. Claude Code:


    ```bash

    claude mcp add --transport http proxies-vision https://proxies.vision/mcp \
      --header "Authorization: Bearer pv_your_key"
    ```


    Reseller tools only show up for reseller keys.
servers:
  - url: https://proxies.vision
security:
  - apiKey: []
tags:
  - name: Account
    description: Balance and bandwidth.
  - name: Proxies
    description: Credentials and ready proxy lists.
  - name: Billing
    description: >-
      Buy bandwidth from the balance and top up with crypto. $1 per GB, never
      expires.
  - name: Reseller
    description: >-
      **Requires reseller access.** Sub-users with their own login and GB from
      your pool.
paths:
  /api/dashboard/credentials:
    get:
      tags:
        - Proxies
      summary: Get credentials
      description: >-
        The gateway host, ports and login of your proxy access. The same login
        works for HTTP and SOCKS5.


        Permission: `lines`
      operationId: get_credentials
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                provisioned: true
                proxy_host: via.proxies.vision
                proxy_port: 9000
                socks_port: 11000
                sticky_port: 10000
                proxy_user: pv7kq2m9xd
                proxy_pass: ••••••••
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key: pv_…'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.