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

# Read the last completed Yield venue scan



## OpenAPI

````yaml /openapi/platform.json get /v1/yield/scan
openapi: 3.1.0
info:
  title: GOL Platform API
  description: >-
    Versioned GOL developer and consumer API. Consumer routes are mounted when
    their runtime integrations are configured.
  version: 0.8.0-rc.1
servers:
  - url: http://localhost:4100
    description: Local development
security: []
tags:
  - name: system
  - name: authentication
  - name: projects
  - name: api-keys
  - name: audit
  - name: gas-executions
  - name: gas-policies
  - name: webhooks
paths:
  /v1/yield/scan:
    get:
      tags:
        - Yield
      summary: Read the last completed Yield venue scan
      operationId: getYieldScan
      responses:
        '200':
          description: Latest scan or an explicit never-ran state
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    required:
                      - status
                    properties:
                      status:
                        type: string
                        enum:
                          - never_ran
                  - type: object
                    required:
                      - status
                      - blockNumber
                      - blockHash
                      - oracle
                      - admitted
                      - excluded
                      - seenNotAdmitted
                      - enumeratedFrom
                      - enumeratedThrough
                    properties:
                      status:
                        type: string
                        enum:
                          - ok
                      blockNumber:
                        pattern: ^(0|[1-9][0-9]*)$
                        type: string
                      blockHash:
                        pattern: ^0x[0-9a-fA-F]{64}$
                        type: string
                      oracle:
                        type: object
                        required:
                          - ok
                        properties:
                          ok:
                            type: boolean
                          reason:
                            type: string
                      admitted:
                        type: array
                        items:
                          type: object
                          required:
                            - venueId
                            - vault
                            - meanYieldBps
                            - historyDays
                            - spotApyBps
                          properties:
                            venueId:
                              type: string
                            vault:
                              pattern: ^0x[0-9a-fA-F]{40}$
                              type: string
                            meanYieldBps:
                              type: integer
                            historyDays:
                              type: integer
                            spotApyBps:
                              type: integer
                      excluded:
                        type: array
                        items:
                          type: object
                          required:
                            - venueId
                            - code
                            - why
                          properties:
                            venueId:
                              type: string
                            code:
                              type: string
                            why:
                              type: string
                      seenNotAdmitted:
                        type: array
                        items:
                          type: object
                          required:
                            - venueId
                            - vault
                            - apyBps
                            - totalAssetsRaw
                          properties:
                            venueId:
                              type: string
                            vault:
                              pattern: ^0x[0-9a-fA-F]{40}$
                              type: string
                            apyBps:
                              type: integer
                            totalAssetsRaw:
                              pattern: ^(0|[1-9][0-9]*)$
                              type: string
                      enumeratedFrom:
                        pattern: ^(0|[1-9][0-9]*)$
                        type: string
                      enumeratedThrough:
                        oneOf:
                          - pattern: ^(0|[1-9][0-9]*)$
                            type: string
                          - type: 'null'

````

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