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

# List routes

> Enabled corridors: direction, rail, assets, countries, limits, and provider. The source of truth for coverage.



## OpenAPI

````yaml /openapi.yaml get /v1/ramp/routes
openapi: 3.1.0
info:
  title: Onstacks Backend API
  version: 0.1.0
  summary: >-
    Public API contract for workspace wallet, transfer, provider routing, API
    key, and webhook flows.
servers:
  - url: https://api.onstacks.io
security: []
tags:
  - name: Health
  - name: Workspace
  - name: Wallets
  - name: Transfers
  - name: Corridors
  - name: Providers
  - name: Quotes
  - name: Ramp
paths:
  /v1/ramp/routes:
    get:
      tags:
        - Ramp
      summary: List routes
      description: >-
        Enabled corridors: direction, rail, assets, countries, limits, and
        provider. The source of truth for coverage.
      parameters:
        - $ref: '#/components/parameters/EnvironmentQuery'
        - in: query
          name: direction
          description: '`on_ramp` or `off_ramp`.'
          required: false
          schema:
            $ref: '#/components/schemas/RampDirection'
        - in: query
          name: rail
          description: Payment rail.
          required: false
          schema:
            $ref: '#/components/schemas/RampRail'
        - in: query
          name: source_asset
          description: Source asset code.
          required: false
          schema:
            type: string
        - in: query
          name: destination_asset
          description: Destination asset code.
          required: false
          schema:
            type: string
        - in: query
          name: country_code
          description: Destination country for off-ramps, source country for on-ramps.
          required: false
          schema:
            type: string
        - in: query
          name: amount
          description: Amount in source units to filter by limits.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Routes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RampRoutesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKeyBearer: []
components:
  parameters:
    EnvironmentQuery:
      in: query
      name: environment
      description: >-
        Environment scope for environment-partitioned resources. Defaults to
        `sandbox` when omitted.
      required: false
      schema:
        $ref: '#/components/schemas/EnvironmentScope'
  schemas:
    RampDirection:
      type: string
      enum:
        - on_ramp
        - off_ramp
    RampRail:
      type: string
      enum:
        - bank
        - mobile_money
        - wallet
        - ach
        - wire
        - sepa
        - faster_payments
        - interac
    RampRoutesResponse:
      type: object
      required:
        - data
        - error
        - request_id
      properties:
        data:
          type: object
          properties:
            items:
              type: array
              items:
                $ref: '#/components/schemas/RampRoute'
        error:
          type: 'null'
        request_id:
          type: string
    EnvironmentScope:
      type: string
      enum:
        - sandbox
        - live
      default: sandbox
    RampRoute:
      type: object
      properties:
        id:
          type: string
        direction:
          $ref: '#/components/schemas/RampDirection'
        rail:
          $ref: '#/components/schemas/RampRail'
        source_asset:
          type: string
        source_network:
          type: string
        destination_asset:
          type: string
        destination_network:
          type: string
        countries:
          type: array
          items:
            type: string
          description: Country codes the route serves. Empty means global.
        minimum_amount:
          type: string
        maximum_amount:
          type: string
        provider:
          type: string
          description: Provider code.
        is_enabled:
          type: boolean
    ErrorEnvelope:
      type: object
      required:
        - data
        - error
        - request_id
      properties:
        data:
          type: 'null'
        error:
          $ref: '#/components/schemas/ApiError'
        request_id:
          type: string
    ApiError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
  responses:
    Unauthorized:
      description: Caller is not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Workspace API key. Send it as `Authorization: Bearer <api_key>`.'

````

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