ipvolt-com API

openapi: 3.1.0
info:
  title: ipvolt-com API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 23 operation(s) read from 15 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; ipvolt-com has published no machine-readable contract
    that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 8
    documentation: 15
    pages-with-code: 15
    pages-read: 15
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://ipvolt.com/guides/curl-proxy-setup.md
  - https://ipvolt.com/es/guides/curl-proxy-setup.md
  - https://ipvolt.com/ru/guides/curl-proxy-setup.md
  - https://ipvolt.com/zh/guides/curl-proxy-setup.md
  - https://ipvolt.com/guides/curl-cffi-proxy-setup.md
  - https://ipvolt.com/es/guides/curl-cffi-proxy-setup.md
  - https://ipvolt.com/ru/guides/curl-cffi-proxy-setup.md
  - https://ipvolt.com/zh/guides/curl-cffi-proxy-setup.md
  - https://ipvolt.com/es/guides/amazon-listing-notifications.md
  - https://ipvolt.com/guides/curl-compressed-accept-encoding.md
  - https://ipvolt.com/ru/guides/amazon-listing-notifications.md
  - https://ipvolt.com/zh/guides/amazon-listing-notifications.md
  - https://ipvolt.com/es/guides/curl-compressed-accept-encoding.md
  - https://ipvolt.com/ru/guides/curl-compressed-accept-encoding.md
  - https://ipvolt.com/zh/guides/curl-compressed-accept-encoding.md
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl opens a CONNECT tunnel through it. Write -x https://host:port only when the provider terminates TLS on the proxy itself.
          curl also accepts socks4://, socks4a://, socks5://and socks5h://here.
  /curl/curl/issues/{issueid}:
    get:
      operationId: get_curl_curl_issues_issueid
      tags:
      - Curl
      summary: GET /curl/curl/issues/{issueId}
      x-source: https://ipvolt.com/guides/curl-compressed-accept-encoding.md
      parameters:
      - name: issueid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl.se/docs/manpage.html#--compressed)). curl reports no error when a server ignores it and has no switch to fail in that case
          ([curl#7516](https://github.com/curl/curl/issues/7516)), so check the bytes as shown below.

          - A hand-set `-H ''Accept-Encoding: gzip''` is sent, but curl does not decode the reply. In the lab, curl output the 17,750-byte gzip
          stream instead of the 100,129-byte page. Use `--'
  /docs/manpage.html:
    get:
      operationId: get_docs_manpage_html
      tags:
      - Docs
      summary: GET /docs/manpage.html
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl starts. curl hides that argument on supported systems only after startup; a later process listing can miss the exposure.
          See the [curl proxy-user documentation](https://curl.se/docs/manpage.html#--proxy-user).
  /downloads/accept-encoding-defaults/harness/snippets/curl-verify.sh:
    get:
      operationId: get_downloads_accept_encoding_defaults_harness_snippets_curl_verify_sh
      tags:
      - Downloads
      summary: Script to verify wire body bytes and Content-Encoding header with curl.
      x-source: https://ipvolt.com/guides/curl-compressed-accept-encoding.md
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDownloadsAcceptEncodingDefaultsHarnessSnippetsCurlVerifyS'
      x-evidence:
        kind: documentation
  /downloads/curl-cffi-proxy-setup/README.md:
    get:
      operationId: get_downloads_curl_cffi_proxy_setup_README_md
      tags:
      - Downloads
      summary: README for the curl_cffi proxy setup lab.
      x-source: https://ipvolt.com/guides/curl-cffi-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /downloads/curl-cffi-proxy-setup/auth_proxy.py:
    get:
      operationId: get_downloads_curl_cffi_proxy_setup_auth_proxy_py
      tags:
      - Downloads
      summary: Proxy implementation with authentication for the lab.
      x-source: https://ipvolt.com/guides/curl-cffi-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /downloads/curl-cffi-proxy-setup/run_lab.py:
    get:
      operationId: get_downloads_curl_cffi_proxy_setup_run_lab_py
      tags:
      - Downloads
      summary: Lab runner script for curl_cffi proxy setup.
      x-source: https://ipvolt.com/guides/curl-cffi-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /downloads/curl-cffi-proxy-setup/versions.json:
    get:
      operationId: get_downloads_curl_cffi_proxy_setup_versions_json
      tags:
      - Downloads
      summary: Version comparison data for curl_cffi and libcurl releases.
      x-source: https://ipvolt.com/guides/curl-cffi-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /en/latest/api.html:
    get:
      operationId: get_en_latest_api_html
      tags:
      - En
      summary: GET /en/latest/api.html
      x-source: https://ipvolt.com/guides/curl-cffi-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl-cffi.readthedocs.io/en/latest/advanced.html#proxies)

          - [curl_cffi API reference: Session (proxy, proxies, proxy_auth, trust_env, retry)](https://curl-cffi.readthedocs.io/en/latest/api.html#curl_cffi.requests.Session)

          - [curl_cffi API reference: AsyncSession](https://curl-cffi.readthedocs.io/en/latest/api.html#curl_cffi.requests.AsyncSession)

          - [curl_cffi API reference: Exceptions and warnings'
  /guides/curl-compressed-accept-encoding.md:
    get:
      operationId: get_guides_curl_compressed_accept_encoding_md
      tags:
      - Guides
      summary: 'curl --compressed: which clients skip compression'
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /guides/curl-proxy-setup.md:
    get:
      operationId: get_guides_curl_proxy_setup_md
      tags:
      - Guides
      summary: 'Use a proxy with curl: -x, env vars, SOCKS5, auth'
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /http/modify/compression.html:
    get:
      operationId: get_http_modify_compression_html
      tags:
      - Http
      summary: GET /http/modify/compression.html
      x-source: https://ipvolt.com/guides/curl-compressed-accept-encoding.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl](https://everything.curl.dev/http/modify/compression.html)).

          - **Browser automation.** Browsers negotiate compression themselves: MDN gives `gzip, deflate, br, zstd` as the typical browser value
          ([MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Encoding)), and Chrome has decoded zstd by default
          since version 123 ([Chrome Platform Status](https://chromestatus.co'
  /libcurl/c/CURLOPT_ACCEPT_ENCODING.html:
    get:
      operationId: get_libcurl_c_CURLOPT_ACCEPT_ENCODING_html
      tags:
      - Libcurl
      summary: GET /libcurl/c/CURLOPT_ACCEPT_ENCODING.html
      x-source: https://ipvolt.com/guides/curl-compressed-accept-encoding.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl URL` sends no `Accept-Encoding` at all. In libcurl, [`CURLOPT_ACCEPT_ENCODING`](https://curl.se/libcurl/c/CURLOPT_ACCEPT_ENCODING.html)
          defaults to NULL, which "makes libcurl not send an `Accept-Encoding:` header and not decompress received contents automatically", and
          the curl tool changes it only for `--compressed`. Neither curl build in the lab sent the header, directly, through an `http:/
  /libcurl/c/CURLOPT_NOPROXY.html:
    get:
      operationId: get_libcurl_c_CURLOPT_NOPROXY_html
      tags:
      - Libcurl
      summary: libcurl CURLOPT_NOPROXY option documentation.
      x-source: https://ipvolt.com/guides/curl-cffi-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /libcurl/c/CURLOPT_PROXY.html:
    get:
      operationId: get_libcurl_c_CURLOPT_PROXY_html
      tags:
      - Libcurl
      summary: libcurl CURLOPT_PROXY option documentation.
      x-source: https://ipvolt.com/guides/curl-cffi-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /libcurl/c/libcurl-env.html:
    get:
      operationId: get_libcurl_c_libcurl_env_html
      tags:
      - Libcurl
      summary: libcurl environment variables documentation.
      x-source: https://ipvolt.com/guides/curl-cffi-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /libcurl/c/libcurl-errors.html:
    get:
      operationId: get_libcurl_c_libcurl_errors_html
      tags:
      - Libcurl
      summary: libcurl error codes
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /manual/en/curl.constants.php:
    get:
      operationId: get_manual_en_curl_constants_php
      tags:
      - Manual
      summary: GET /manual/en/curl.constants.php
      x-source: https://ipvolt.com/guides/curl-compressed-accept-encoding.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl** (PHP 8.5.8 with libcurl 8.20.0) sends nothing, because `CURLOPT_ACCEPT_ENCODING` "Defaults to null" ([PHP manual](https://www.php.net/manual/en/curl.constants.php)).
          `CURLOPT_ACCEPT_ENCODING => ''''` asks for every coding the linked libcurl supports, `deflate, gzip, br, zstd` in this build, and decodes.
          An `Accept-Encoding` line in `CURLOPT_HTTPHEADER` is sent but not decoded.

          - **Guzzle 8.2.'
  /opensearch-project/OpenSearch/issues/{issueid}:
    get:
      operationId: get_opensearch_project_OpenSearch_issues_issueid
      tags:
      - Opensearch Project
      summary: GET /opensearch-project/OpenSearch/issues/{issueId}
      x-source: https://ipvolt.com/guides/curl-compressed-accept-encoding.md
      parameters:
      - name: issueid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl builds with zstd support. It was fixed for 2.19.1 and 3.0.0 ([OpenSearch#17339](https://github.com/opensearch-project/OpenSearch/issues/17339)).
          If one host times out only for zstd-capable clients, a request that asks for gzip only will show whether zstd negotiation is the problem.
  /transfers/conn/proxies.html:
    get:
      operationId: get_transfers_conn_proxies_html
      tags:
      - Transfers
      summary: 'Everything curl: separate proxy and destination connections'
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /usingcurl/proxies/auth.html:
    get:
      operationId: get_usingcurl_proxies_auth_html
      tags:
      - Usingcurl
      summary: 'Everything curl: proxy authentication'
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /usingcurl/proxies/env.html:
    get:
      operationId: get_usingcurl_proxies_env_html
      tags:
      - Usingcurl
      summary: 'Everything curl: proxy environment variables'
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /usingcurl/proxies/socks.html:
    get:
      operationId: get_usingcurl_proxies_socks_html
      tags:
      - Usingcurl
      summary: 'Everything curl: SOCKS proxies and hostname resolution'
      x-source: https://ipvolt.com/guides/curl-proxy-setup.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetDownloadsAcceptEncodingDefaultsHarnessSnippetsCurlVerifyS:
      type: object
      properties:
        shell script:
          type: string
tags:
- name: Api
- name: Curl
- name: Docs
- name: Downloads
- name: En
- name: Guides
- name: Http
- name: Libcurl
- name: Manual
- name: Opensearch Project
- name: Transfers
- name: Usingcurl