openapi: 3.2.0
info:
  title: Earn Provider Server Grow API
  version: 1.1.0
tags:
- name: Grow
paths:
  /v1/grow:
    get:
      description: Get interest rates for all available networks
      operationId: getV0Grow
      responses:
        '200':
          description: ''
          headers:
            Cache-Control:
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GrowResponse'
                example:
                - network: ethereum
                  deposit_token: ethereum/erc20/staked_aave_balance_pool_token
                  interest:
                    type: APY
                    value: '5.3'
                    currency: ethereum/erc20/staked_aave_balance_pool_token
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
              example:
                realm: earn
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
              example:
                what: 0x00000000000 not found
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - Grow
components:
  schemas:
    ServerError:
      title: ServerError
      type: object
      required:
      - msg
      properties:
        msg:
          type: string
    Failure1:
      title: Failure
      type: object
      required:
      - network
      - error
      properties:
        network:
          type: string
        error:
          $ref: '#/components/schemas/FailureView'
    NotFound:
      title: NotFound
      type: object
      required:
      - what
      properties:
        what:
          type: string
    Success1:
      title: Success
      type: object
      required:
      - network
      - deposit_token
      - interest
      properties:
        network:
          description: The network name
          type: string
        deposit_token:
          description: The deposit token
          type: string
        interest:
          $ref: '#/components/schemas/ProtocolInterestView'
          description: The interest information
    ProtocolInterestView:
      title: InterestView
      type: object
      required:
      - type
      - value
      - currency
      properties:
        type:
          description: The type of interest - APY
          type: string
        value:
          description: The protocol's Net APY interest rate.
          type: string
        currency:
          description: Ledger crypto currency ID
          type: string
    Map_String:
      title: Map_String
      type: object
      additionalProperties:
        type: string
    Unauthorized:
      title: Unauthorized
      type: object
      required:
      - realm
      properties:
        realm:
          type: string
    GrowResponse:
      title: GrowResponse
      oneOf:
      - $ref: '#/components/schemas/Success1'
      - $ref: '#/components/schemas/Failure1'
    FailureView:
      title: FailureView
      type: object
      required:
      - code
      - reason
      - details
      properties:
        code:
          description: The error code
          type: integer
          format: int32
        reason:
          description: The error reason
          type: string
        details:
          $ref: '#/components/schemas/Map_String'
          description: The error details