finedata-ai

finedata-ai Proxy Profiles (BYOP) API

Bring Your Own Proxy — save encrypted proxy lists and reference them by `proxy_profile_id` in scrape requests. **Requirements:** `team_s` plan or higher (or admin `allow_byop` override). **Pricing:** +1 token per request (stacks on top of antibot/render fees; replaces vendor proxy surcharges +2/+3/+4). **Limits:** up to 10 profiles per user, 100 proxies per profile. Credentials are Fernet-encrypted at rest; list endpoints never return decrypted URLs. **Rotation:** `round_robin` (default) or `sticky` (same exit IP per `session_id`). Failed proxies can be auto-skipped for 5 minutes when `auto_skip_failed` is enabled. Manage profiles in the dashboard at `/proxy-profiles` or via the endpoints below.

Documentation GitHub OpenAPI

Operations 6

POST /api/v1/proxy-profiles Create Profile #

GET /api/v1/proxy-profiles List Profiles #

GET /api/v1/proxy-profiles/{profile_id} Get Profile #

PUT /api/v1/proxy-profiles/{profile_id} Update Profile #

DELETE /api/v1/proxy-profiles/{profile_id} Delete Profile #

POST /api/v1/proxy-profiles/{profile_id}/test Test Profile #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/finedata-ai/openapi/finedata-ai-proxy-profiles-byop-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/finedata-ai/json-schema/finedata-ai-public-scrape-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/finedata-ai/json-schema/finedata-ai-async-scrape-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/finedata-ai/json-schema/finedata-ai-async-job-status-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/finedata-ai/json-schema/finedata-ai-public-scrape-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/finedata-ai/json-schema/finedata-ai-serp-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/finedata-ai/json-schema/finedata-ai-batch-job-status-response-schema.json

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/finedata-ai:finedata-ai-proxy-profiles-byop-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Finedata Ai Proxy Profiles (BYOP) API
  version: 1.0.0
  description: 'Operations tagged Proxy Profiles (BYOP) across 2 of this provider''s published API definitions: finedata-ai.json, finedata-openapi.json. Each path carries the servers of the definition it was published in.'
security:
- BearerAuth: []
tags:
- name: Proxy Profiles (BYOP)
  description: 'Bring Your Own Proxy — save encrypted proxy lists and reference them by `proxy_profile_id` in scrape requests.


    **Requirements:** `team_s` plan or higher (or admin `allow_byop` override).


    **Pricing:** +1 token per request (stacks on top of antibot/render fees; replaces vendor proxy surcharges +2/+3/+4).


    **Limits:** up to 10 profiles per user, 100 proxies per profile. Credentials are Fernet-encrypted at rest; list endpoints never return decrypted URLs.


    **Rotation:** `round_robin` (default) or `sticky` (same exit IP per `session_id`). Failed proxies can be auto-skipped for 5 minutes when `auto_skip_failed` is enabled.


    Manage profiles in the dashboard at `/proxy-profiles` or via the endpoints below.'
paths:
  /api/v1/proxy-profiles:
    post:
      tags:
      - Proxy Profiles (BYOP)
      summary: Create Profile
      description: Create an encrypted BYOP profile. Requires team_s+ plan. Up to 10 profiles and 100 proxies per profile.
      operationId: create_profile_api_v1_proxy_profiles_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyProfileCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Proxy Profiles (BYOP)
      summary: List Profiles
      description: List BYOP profiles for the authenticated user. Credentials are never returned.
      operationId: list_profiles_api_v1_proxy_profiles_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyProfileListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/proxy-profiles/{profile_id}:
    get:
      tags:
      - Proxy Profiles (BYOP)
      summary: Get Profile
      description: Get profile metadata by id (no decrypted proxy URLs).
      operationId: get_profile_api_v1_proxy_profiles__profile_id__get
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: integer
          title: Profile Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Proxy Profiles (BYOP)
      summary: Update Profile
      description: Update name, proxy list, rotation mode, or auto_skip_failed.
      operationId: update_profile_api_v1_proxy_profiles__profile_id__put
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: integer
          title: Profile Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyProfileUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Proxy Profiles (BYOP)
      summary: Delete Profile
      description: Permanently delete a BYOP profile.
      operationId: delete_profile_api_v1_proxy_profiles__profile_id__delete
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: integer
          title: Profile Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/proxy-profiles/{profile_id}/test:
    post:
      tags:
      - Proxy Profiles (BYOP)
      summary: Test Profile
      description: Health-check each proxy in the profile via https://httpbin.org/ip. Returns masked URLs and per-proxy latency.
      operationId: test_profile_api_v1_proxy_profiles__profile_id__test_post
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: integer
          title: Profile Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyTestResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ProxyProfileCreateRequest:
      properties:
        name:
          type: string
          maxLength: 128
          minLength: 1
          title: Name
        proxies:
          items:
            type: string
          type: array
          maxItems: 100
          minItems: 1
          title: Proxies
        rotation_mode:
          type: string
          enum:
          - round_robin
          - sticky
          title: Rotation Mode
          default: round_robin
        auto_skip_failed:
          type: boolean
          title: Auto Skip Failed
          default: true
      type: object
      required:
      - name
      - proxies
      title: ProxyProfileCreateRequest
      example:
        auto_skip_failed: true
        name: My residential pool
        proxies:
        - http://user:pass@proxy1.example.com:8080
        - socks5://user:pass@proxy2.example.com:1080
        rotation_mode: round_robin
    ProxyProfileListResponse:
      properties:
        profiles:
          items:
            $ref: '#/components/schemas/ProxyProfileResponse'
          type: array
          title: Profiles
        total:
          type: integer
          title: Total
        max_profiles:
          type: integer
          title: Max Profiles
      type: object
      required:
      - profiles
      - total
      - max_profiles
      title: ProxyProfileListResponse
    ProxyProfileUpdateRequest:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 128
            minLength: 1
          - type: 'null'
          title: Name
        proxies:
          anyOf:
          - items:
              type: string
            type: array
            maxItems: 100
          - type: 'null'
          title: Proxies
        rotation_mode:
          anyOf:
          - type: string
            enum:
            - round_robin
            - sticky
          - type: 'null'
          title: Rotation Mode
        auto_skip_failed:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Auto Skip Failed
      type: object
      title: ProxyProfileUpdateRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProxyTestResponse:
      properties:
        profile_id:
          type: integer
          title: Profile Id
        tested:
          type: integer
          title: Tested
        succeeded:
          type: integer
          title: Succeeded
        failed:
          type: integer
          title: Failed
        results:
          items:
            $ref: '#/components/schemas/ProxyTestResult'
          type: array
          title: Results
      type: object
      required:
      - profile_id
      - tested
      - succeeded
      - failed
      - results
      title: ProxyTestResponse
    ProxyTestResult:
      properties:
        index:
          type: integer
          title: Index
        proxy:
          type: string
          title: Proxy
        ok:
          type: boolean
          title: Ok
        latency_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Latency Ms
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - index
      - proxy
      - ok
      title: ProxyTestResult
    ProxyProfileResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        proxy_count:
          type: integer
          title: Proxy Count
        rotation_mode:
          type: string
          title: Rotation Mode
        auto_skip_failed:
          type: boolean
          title: Auto Skip Failed
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated At
        last_used_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Used At
      type: object
      required:
      - id
      - name
      - proxy_count
      - rotation_mode
      - auto_skip_failed
      title: ProxyProfileResponse
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API key obtained from the dashboard. Pass as `Authorization: Bearer fd_...`'
x-refined-from:
- finedata-ai.json
- finedata-openapi.json