Abstract API Web Scraping API

Web content extraction operations

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/email-reputation-breach-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/phone-intelligence-phone-country-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/ip-geolocation-currency-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/ip-intelligence-asn-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/company-enrichment-company-enrichment-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/exchange-rates-convert-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/public-holidays-holiday-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/timezones-convert-time-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/vat-validation-vat-calculate-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/iban-validation-iban-validation-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/image-processing-image-processing-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/web-scraping-web-scraping-response-schema.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/email-reputation-breach-info-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/phone-intelligence-phone-country-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/ip-geolocation-currency-info-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/ip-intelligence-asn-info-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/company-enrichment-company-enrichment-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/exchange-rates-convert-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/public-holidays-holiday-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/timezones-convert-time-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/vat-validation-vat-calculate-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/iban-validation-iban-validation-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/image-processing-image-processing-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/examples/web-scraping-web-scraping-response-example.json

OpenAPI Specification

abstract-api-web-scraping-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Abstract API Avatars Web Scraping API
  description: Create highly customizable avatar images using a person's name or initials. Supports color, font, and size customization for user profile images.
  version: 1.0.0
  contact:
    url: https://www.abstractapi.com/
  x-generated-from: documentation
servers:
- url: https://avatars.abstractapi.com/v1
  description: Avatars API v1
security:
- apiKey: []
tags:
- name: Web Scraping
  description: Web content extraction operations
paths:
  /:
    get:
      operationId: scrapeWebPage
      summary: Abstract API Scrape Web Page
      description: Extract the full HTML content of any website URL, with support for JavaScript-rendered pages.
      tags:
      - Web Scraping
      parameters:
      - name: api_key
        in: query
        required: true
        description: Your unique API key for the Web Scraping API.
        schema:
          type: string
        example: abc123def456
      - name: url
        in: query
        required: true
        description: The URL of the webpage to scrape.
        schema:
          type: string
          format: uri
        example: https://www.example.com
      - name: render_js
        in: query
        required: false
        description: Whether to render JavaScript before returning HTML. Defaults to false.
        schema:
          type: boolean
        example: false
      responses:
        '200':
          description: Scraped HTML content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebScrapingResponse'
              examples:
                scrapeWebPage200Example:
                  summary: Default scrapeWebPage 200 response
                  x-microcks-default: true
                  value:
                    body: <html><head><title>Example Domain</title></head><body>...</body></html>
                    url: https://www.example.com
                    status_code: 200
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          example: The provided API key is invalid
        error:
          type: string
          example: invalid_api_key
    WebScrapingResponse:
      type: object
      description: Web scraping result
      properties:
        body:
          type: string
          description: Full HTML content of the page
          example: <html><head><title>Example Domain</title></head><body>...</body></html>
        url:
          type: string
          format: uri
          description: Final URL after redirects
          example: https://www.example.com
        status_code:
          type: integer
          description: HTTP status code of the scraped page
          example: 200
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: api_key