---
title: "Residential gateway credentials"
method: GET
path: "/api/v1/residential/credentials"
---

# Residential gateway credentials

`GET /api/v1/residential/credentials`

## Request

- Base URL: `https://ipmusk.com`
- URL: `https://ipmusk.com/api/v1/residential/credentials`
- Auth: HTTP bearer

Gateway host and port, the proxy username and password, and the traffic left. Returns a password: call it only when the user wants to connect. 404 not_found when there is no usable residential traffic (never bought, still being delivered, used up, expired or disabled); the message says which.

## Response `200`

Residential gateway credentials

- object
  - `data` object, required
    - `gateway` object, required
      - `host` string, required
      - `port` integer, required
    - `account` string, required
    - `username` string, required
    - `password` string, required
    - `traffic` object, required
      - `active_packages` integer, required
      - `remaining_bytes` integer, required
      - `total_bytes` integer, nullable, required
      - `earliest_expiry` string, date-time, nullable, required
    - `pending_delivery` boolean, required
    - `countries` string[], required
  - `request_id` string, required

## Other responses

- `default`: Any failure: 400 validation_error, 401 authentication_required, 403 forbidden / capability_unavailable, 404 not_found, 409 invalid_state_transition / idempotency_conflict, 422 product_unavailable, 429 rate_limited, 500 internal_error.

---

[API](https://skmtc.dev/ipmusk/apis/ipmusk-customer-api.md) · [All operations](https://skmtc.dev/ipmusk/apis/ipmusk-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ipmusk/apis/ipmusk-customer-api/revisions/89f8b46fda61?raw)