> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yield.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# List providers

> List the perps providers with their network, supported actions and a JSON Schema of the arguments each action takes.

Returns an array, not a paginated object. `supportedActions` and `argumentSchemas` are the authoritative list of what a provider accepts; per-action arguments are summarized in [Action arguments](https://docs.yield.xyz/api-reference/perps-api/objects.md#action-arguments). Provider IDs are listed in [Providers](https://docs.yield.xyz/api-reference/perps-api/objects.md#providers).


## OpenAPI

````yaml openapi-perps.json GET /v1/providers
openapi: 3.0.0
info:
  title: 'Yield API: Trade (Perps)'
  description: >-
    API Documentation. Errors follow a uniform envelope with `details.code` from
    the public catalog (https://docs.yield.xyz). ValidationPipe failures use
    `validation.message: string[]`.
  version: '1.0'
  contact: {}
servers:
  - url: https://perps.yield.xyz
    description: Production
security: []
tags:
  - name: Discovery
    description: Browse and discover perps markets, networks, and providers
  - name: Portfolio
    description: User-specific positions, orders, and balances
  - name: Actions
    description: Generate transactions to open, close, and manage positions
externalDocs:
  description: For more information
  url: https://docs.yield.xyz
paths:
  /v1/providers:
    get:
      tags:
        - Providers
        - Discovery
      summary: List all providers
      description: >-
        Retrieve a list of available perps trading providers with their
        supported actions and argument schemas.
      operationId: ProvidersController_getProviders_v1
      parameters: []
      responses:
        '200':
          description: List of all providers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProviderDto'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    example: 401
                  timestamp:
                    type: string
                    example: '2026-05-04T12:00:00.000Z'
                  path:
                    type: string
                    example: /v1/actions
                  message:
                    type: string
                    example: Invalid API key
                  details:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Invalid API key
                      code:
                        type: string
                        example: AUTH_INVALID_API_KEY
        '429':
          description: Rate limit exceeded
          headers:
            x-ratelimit-limit:
              description: Request limit per window
              schema:
                type: string
            x-ratelimit-remaining:
              description: Remaining requests (will be 0)
              schema:
                type: string
            x-ratelimit-reset:
              description: Unix timestamp when window resets
              schema:
                type: string
            retry-after:
              description: Seconds to wait before retrying
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    example: 429
                  timestamp:
                    type: string
                    example: '2026-05-04T12:00:00.000Z'
                  path:
                    type: string
                    example: /v1/actions
                  message:
                    type: string
                    example: Rate limit exceeded
                  details:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Rate limit exceeded
                      code:
                        type: string
                        example: RATE_LIMIT_EXCEEDED
                      error:
                        type: string
                        example: Too Many Requests
                      retryAfter:
                        type: number
                        example: 30
      security:
        - ApiKey: []
components:
  schemas:
    ProviderDto:
      type: object
      properties:
        id:
          type: string
          description: Provider identifier
          example: hyperliquid
        name:
          type: string
          description: Provider name
          example: Hyperliquid
        network:
          type: string
          description: Network the provider operates on
          example: hyperliquid
        metadata:
          description: Provider metadata (description, logo, links)
          allOf:
            - $ref: '#/components/schemas/ProviderMetadataDto'
        supportedActions:
          description: Supported action types
          example:
            - open
            - close
            - updateLeverage
          allOf:
            - $ref: '#/components/schemas/PerpActionTypes'
        argumentSchemas:
          type: object
          description: Argument schemas for each supported action (JSON Schema format)
          additionalProperties:
            $ref: '#/components/schemas/ArgumentSchemaDto'
          example:
            open:
              type: object
              properties:
                marketId:
                  type: string
                  label: Market
                side:
                  enum:
                    - long
                    - short
                  label: Side
                leverage:
                  type: number
                  label: Leverage
              required:
                - marketId
                - side
                - leverage
      required:
        - id
        - name
        - network
        - metadata
        - supportedActions
        - argumentSchemas
    ProviderMetadataDto:
      type: object
      properties:
        description:
          type: string
          description: Provider description
          example: >-
            Hyperliquid is a high-performance L1 optimized for perpetual futures
            trading.
        externalLink:
          type: string
          description: External link to the provider website
          example: https://hyperliquid.xyz
        logoURI:
          type: string
          description: Provider logo URI
          example: https://assets.stakek.it/providers/hyperliquid.svg
      required:
        - description
        - externalLink
        - logoURI
    PerpActionTypes:
      type: string
      enum:
        - open
        - close
        - updateLeverage
        - stopLoss
        - takeProfit
        - cancelOrder
        - editOrder
        - fund
        - withdraw
        - approveAgent
        - approveBuilderFee
        - updateMargin
        - setTpAndSl
        - setUnifiedAccount
      description: Supported action types
    ArgumentSchemaDto:
      type: object
      properties:
        type:
          type: object
          description: Schema type
          example: object
        properties:
          type: object
          description: Schema properties (fields)
          example:
            marketId:
              type: string
              label: Market
              optionsRef: markets
            leverage:
              type: integer
              minimum: 1
              maximum: 50
              label: Leverage
        required:
          description: Required field names
          example:
            - marketId
            - side
            - leverage
          type: array
          items:
            type: string
        additionalProperties:
          type: object
          description: Allow additional properties
          example: false
        items:
          description: Array items schema
          allOf:
            - $ref: '#/components/schemas/ArgumentSchemaPropertyDto'
        enum:
          description: Enum values
          type: array
          items:
            type: string
        default:
          type: object
          description: Default value
        notes:
          type: string
          description: Notes about this action schema
          example: You can specify either amount or size
    ArgumentSchemaPropertyDto:
      type: object
      properties:
        type:
          type: object
          description: Property type
          example: string
        description:
          type: string
          description: Property description
        enum:
          description: Enum values
          example:
            - long
            - short
          type: array
          items:
            type: string
        default:
          type: object
          description: Default value
        minimum:
          type: number
          description: Minimum value
        maximum:
          type: number
          description: Maximum value
        minLength:
          type: number
          description: Minimum length
        maxLength:
          type: number
          description: Maximum length
        pattern:
          type: string
          description: Regex pattern
        items:
          description: Items schema (for arrays)
          allOf:
            - $ref: '#/components/schemas/ArgumentSchemaPropertyDto'
        properties:
          type: object
          description: Nested properties (for objects)
        required:
          description: Required nested fields
          type: array
          items:
            type: string
        additionalProperties:
          type: object
          description: Additional properties allowed
        label:
          type: string
          description: Field label for UI
          example: Leverage
        placeholder:
          type: string
          description: Placeholder text
          example: '10'
        optionsRef:
          type: string
          description: Reference to dynamic options
          example: markets
        options:
          description: Static option values
          example:
            - isolated
            - cross
          type: array
          items:
            type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.