IPMusk Me API

The Me API from IPMusk — 1 operation(s) for me.

GitHub OpenAPI

Operations 1

GET /api/v1/me The account behind the key #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/ipmusk-com:ipmusk-com-me-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ipmusk-com-me-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: IPMusk Customer Me API
  version: 1.0.0
  description: 'Read the catalogue, get residential and static proxy credentials, check usage and orders, and handle support tickets. Authenticate with an API key from the dashboard (Settings > API keys) sent as `Authorization: Bearer `; each key carries the scopes read, connect and/or support. Rate limits per key and minute: read 60, connect 20, support 30 (429 rate_limited, with a Retry-After header in seconds). JSON responses are `{ data, request_id }`; errors are `{ error: { code, message, field_errors? }, request_id }`. Money is amount_minor (minor units) with an ISO 4217 currency.'
servers:
- url: https://ipmusk.com
tags:
- name: Me
paths:
  /api/v1/me:
    get:
      operationId: me_get
      summary: The account behind the key
      description: Customer id, email, display name, language and time zone, plus the calling key's id and scopes.
      security:
      - bearerAuth: []
      x-ipmusk-scope: read
      parameters: []
      responses:
        '200':
          description: The account behind the key
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      customer:
                        type: object
                        properties:
                          id:
                            type: string
                            minLength: 1
                            maxLength: 128
                          email:
                            type: string
                            format: email
                            pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
                          display_name:
                            anyOf:
                            - type: string
                              minLength: 1
                              maxLength: 80
                            - type: 'null'
                          locale:
                            type: string
                            enum:
                            - en
                            - es
                            - it
                            - fr
                            - zh-Hant
                            - de
                            - vi
                            - ru
                            - pt
                            - ko
                            - ja
                            - ar
                            - id
                          timezone:
                            type: string
                            minLength: 1
                            maxLength: 80
                          email_verified:
                            type: boolean
                          account_status:
                            type: string
                            enum:
                            - active
                            - suspended
                        required:
                        - id
                        - email
                        - display_name
                        - locale
                        - timezone
                        - email_verified
                        - account_status
                        additionalProperties: false
                      api_key:
                        type: object
                        properties:
                          id:
                            type: string
                            minLength: 1
                            maxLength: 128
                          scopes:
                            type: array
                            items:
                              type: string
                              enum:
                              - read
                              - connect
                              - support
                              - order
                        required:
                        - id
                        - scopes
                        additionalProperties: false
                    required:
                    - customer
                    - api_key
                    additionalProperties: false
                  request_id:
                    type: string
                    minLength: 8
                    maxLength: 128
                required:
                - data
                - request_id
                additionalProperties: false
        default:
          $ref: '#/components/responses/Error'
      tags:
      - Me
components:
  responses:
    Error:
      description: '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.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - validation_error
              - authentication_required
              - region_blocked
              - forbidden
              - not_found
              - idempotency_conflict
              - invalid_state_transition
              - checkout_unavailable
              - product_unavailable
              - capability_unavailable
              - rate_limited
              - challenge_required
              - upstream_unavailable
              - internal_error
            message:
              type: string
              minLength: 1
              maxLength: 500
            field_errors:
              type: object
              propertyNames:
                type: string
              additionalProperties:
                type: array
                items:
                  type: string
                  minLength: 1
                  maxLength: 300
          required:
          - code
          - message
          additionalProperties: false
        request_id:
          type: string
          minLength: 8
          maxLength: 128
      required:
      - error
      - request_id
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An IPMusk API key (ipm_live_…).