openapi: 3.0.3
info:
  title: Oxylabs Web Intelligence APIs Login API
  description: Oxylabs provides web scraping and data extraction APIs including the Web Scraper API (Realtime and Push-Pull), the Dashboard API for usage and statistics, and the Residential Public API for sub-user and stats management.
  version: '1.0'
  contact:
    name: Oxylabs Developer Support
    url: https://developers.oxylabs.io/
servers:
- url: https://realtime.oxylabs.io/v1
  description: Web Scraper API - Realtime
- url: https://data.oxylabs.io/v1
  description: Web Scraper API - Push-Pull
- url: https://api.oxylabs.io
  description: Dashboard API
- url: https://residential-api.oxylabs.io/v2
  description: Residential Public API
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Login
paths:
  /login:
    post:
      summary: Residential API login
      description: Exchange username and password (basic auth) for a bearer token.
      operationId: residentialLogin
      security:
      - basicAuth: []
      responses:
        '200':
          description: Auth token issued
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: integer
                  token:
                    type: string
      tags:
      - Login
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer