LayerZero

LayerZero messages API

The messages API from LayerZero — 7 operation(s) for messages.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.layerzero.network/v2/tools/overview
📖
Documentation
https://docs.layerzero.network/v2/developers/value-transfer-api/api-reference/overview
📖
Authentication
https://docs.layerzero.network/v2/developers/value-transfer-api/api-reference/overview
📖
Documentation
https://docs.layerzero.network/v2/tools/api/oft-examples
📖
Authentication
https://docs.layerzero.network/v2/tools/api/oft-reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/layerzero/refs/heads/main/openapi/layerzero-messages-api-openapi.yml

Other Resources

🔗
Explorer
https://layerzeroscan.com/
🔗
Swagger
https://scan.layerzero-api.com/v1/swagger

OpenAPI Specification

layerzero-messages-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: LayerZero OFT Transfer Discovery messages API
  version: 1.0.0
  description: API for LayerZero Omnichain Fungible Tokens (OFTs)
servers:
- url: https://metadata.layerzero-api.com/v1/metadata/experiment/ofts
tags:
- name: messages
paths:
  /messages/latest:
    get:
      description: Get latest messages
      tags:
      - messages
      parameters:
      - in: query
        name: ulnVersion
        schema:
          type: string
          example: V302
      - in: query
        name: limit
        schema:
          anyOf:
          - type: number
          - type: string
          default: 100
      - in: query
        name: start
        schema:
          anyOf:
          - type: number
          - type: string
          - type: string
          description: Start Date in ISO String format
          example: '2024-05-27T19:20:52.812Z'
      - in: query
        name: end
        schema:
          anyOf:
          - type: number
          - type: string
          - type: string
          description: End Date in ISO String format
          example: '2024-05-27T19:20:52.812Z'
      - in: query
        name: nextToken
        description: The token to be passed for retrieving the next set of paginated results
        schema:
          type: string
          description: The token to be passed for retrieving the next set of paginated results
      responses:
        '200':
          description: 200 OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        pathway:
                          type: object
                          properties:
                            srcEid:
                              type: number
                            dstEid:
                              type: number
                            sender:
                              type: object
                              properties:
                                address:
                                  type: string
                                id:
                                  type: string
                                name:
                                  type: string
                                chain:
                                  type: string
                            receiver:
                              type: object
                              properties:
                                address:
                                  type: string
                                id:
                                  type: string
                                name:
                                  type: string
                                chain:
                                  type: string
                            id:
                              type: string
                            nonce:
                              type: number
                        source:
                          type: object
                          properties:
                            status:
                              anyOf:
                              - type: string
                                enum:
                                - WAITING
                              - type: string
                                enum:
                                - VALIDATING_TX
                              - type: string
                                enum:
                                - SUCCEEDED
                              - type: string
                                enum:
                                - WAITING_FOR_HASH_DELIVERED
                              - type: string
                                enum:
                                - UNRESOLVABLE_COMMAND
                              - type: string
                                enum:
                                - MALFORMED_COMMAND
                            tx:
                              type: object
                              properties:
                                txHash:
                                  type: string
                                blockHash:
                                  type: string
                                blockNumber:
                                  type: string
                                blockTimestamp:
                                  type: number
                                from:
                                  type: string
                                blockConfirmations:
                                  type: number
                                payload:
                                  type: string
                                value:
                                  type: string
                                readinessTimestamp:
                                  type: number
                                resolvedPayload:
                                  type: string
                                adapterParams:
                                  type: object
                                  properties:
                                    version:
                                      type: string
                                    dstGasLimit:
                                      type: string
                                    dstNativeGasTransferAmount:
                                      type: string
                                    dstNativeGasTransferAddress:
                                      type: string
                                options:
                                  type: object
                                  properties:
                                    lzReceive:
                                      type: object
                                      properties:
                                        gas:
                                          type: string
                                        value:
                                          type: string
                                    nativeDrop:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          amount:
                                            type: string
                                          receiver:
                                            type: string
                                    compose:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          index:
                                            type: number
                                          gas:
                                            type: string
                                          value:
                                            type: string
                                    ordered:
                                      type: boolean
                            failedTx:
                              type: array
                              items:
                                type: string
                        destination:
                          anyOf:
                          - type: object
                            properties:
                              status:
                                anyOf:
                                - type: string
                                  enum:
                                  - WAITING
                                - type: string
                                  enum:
                                  - VALIDATING_TX
                                - type: string
                                  enum:
                                  - SUCCEEDED
                                - type: string
                                  enum:
                                  - PAYLOAD_STORED
                              tx:
                                type: object
                                properties:
                                  txHash:
                                    type: string
                                  blockHash:
                                    type: string
                                  blockNumber:
                                    type: number
                                  blockTimestamp:
                                    type: number
                              payloadStoredTx:
                                type: string
                              failedTx:
                                type: array
                                items:
                                  type: string
                          - type: object
                            properties:
                              nativeDrop:
                                type: object
                                properties:
                                  tx:
                                    type: object
                                    properties:
                                      txHash:
                                        type: string
                                      blockHash:
                                        type: string
                                      blockNumber:
                                        type: number
                                      blockTimestamp:
                                        type: number
                                  failedTx:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        txHash:
                                          type: string
                                        txError:
                                          type: string
                                  appliedResults: {}
                                  status:
                                    anyOf:
                                    - type: string
                                      enum:
                                      - WAITING
                                    - type: string
                                      enum:
                                      - VALIDATING_TX
                                    - type: string
                                      enum:
                                      - SUCCEEDED
                                    - type: string
                                      enum:
                                      - FAILED
                                    - type: string
                                      enum:
                                      - N/A
                              nilify:
                                type: object
                                properties:
                                  txStatus:
                                    anyOf:
                                    - type: string
                                      enum:
                                      - WAITING
                                    - type: string
                                      enum:
                                      - VALIDATING_TX
                                    - type: string
                                      enum:
                                      - SUCCEEDED
                                  txHash:
                                    type: string
                                  blockHash:
                                    type: string
                                  blockNumber:
                                    type: number
                                  blockTimestamp:
                                    type: number
                              burn:
                                type: object
                                properties:
                                  txStatus:
                                    anyOf:
                                    - type: string
                                      enum:
                                      - WAITING
                                    - type: string
                                      enum:
                                      - VALIDATING_TX
                                    - type: string
                                      enum:
                                      - SUCCEEDED
                                  txHash:
                                    type: string
                                  blockHash:
                                    type: string
                                  blockNumber:
                                    type: number
                                  blockTimestamp:
                                    type: number
                              skip:
                                type: object
                                properties:
                                  txStatus:
                                    anyOf:
                                    - type: string
                                      enum:
                                      - WAITING
                                    - type: string
                                      enum:
                                      - VALIDATING_TX
                                    - type: string
                                      enum:
                                      - SUCCEEDED
                                  txHash:
                                    type: string
                                  blockHash:
                                    type: string
                                  blockNumber:
                                    type: number
                                  blockTimestamp:
                                    type: number
                              lzCompose:
                                type: object
                                properties:
                                  txs:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        txHash:
                                          type: string
                                        blockHash:
                                          type: string
                                        blockNumber:
                                          type: number
                                        blockTimestamp:
                                          type: number
                                        from:
                                          type: string
                                        to:
                                          type: string
                                  failedTx:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        txHash:
                                          type: string
                                        txError:
                                          type: string
                                        from:
                                          type: string
                                        to:
                                          type: string
                                        index:
                                          type: number
                                        revertReason:
                                          type: string
                                          nullable: true
                                  status:
                                    anyOf:
                                    - type: string
                                      enum:
                                      - WAITING
                                    - type: string
                                      enum:
                                      - VALIDATING_TX
                                    - type: string
                                      enum:
                                      - SUCCEEDED
                                    - type: string
                                      enum:
                                      - N/A
                                    - type: string
                                      enum:
                                      - FAILED
                                    - type: string
                                      enum:
                                      - SIMULATION_REVERTED
                                    - type: string
                                      enum:
                                      - WAITING_FOR_COMPOSE_SENT_EVENT
                              tx:
                                type: object
                                properties:
                                  txHash:
                                    type: string
                                  blockHash:
                                    type: string
                                  blockNumber:
                                    type: number
                                  blockTimestamp:
                                    type: number
                              payloadStoredTx:
                                type: string
                              failedTx:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    txHash:
                                      type: string
                                    txError:
                                      type: string
                                    blockHash:
                                      type: string
                                    blockNumber:
                                      type: number
                                    revertReason:
                                      type: string
                                      nullable: true
                              status:
                                anyOf:
                                - type: string
                                  enum:
                                  - WAITING
                                - type: string
                                  enum:
                                  - VALIDATING_TX
                                - type: string
                                  enum:
                                  - SUCCEEDED
                                - type: string
                                  enum:
                                  - FAILED
                                - type: string
                                  enum:
                                  - SIMULATION_REVERTED
                                - type: string
                                  enum:
                                  - PAYLOAD_STORED
                                - type: string
                                  enum:
                                  - RESOLVED_PAYLOAD_SIZE_NOT_PAID
                        verification:
                          type: object
                          properties:
                            dvn:
                              type: object
                              properties:
                                dvns:
                                  type: object
                                  additionalProperties:
                                    anyOf:
                                    - type: object
                                      properties:
                                        txHash:
                                          type: string
                                        blockHash:
                                          type: string
                                        blockNumber:
                                          type: number
                                        blockTimestamp:
                                          type: number
                                        proof:
                                          type: object
                                          properties:
                                            packetHeader:
                                              type: string
                                            payloadHash:
                                              type: string
                                        optional:
                                          type: boolean
                                        status:
                                          anyOf:
                                          - type: string
                                            enum:
                                            - VALIDATING_TX
                                          - type: string
                                            enum:
                                            - SUCCEEDED
                                          - type: string
                                            enum:
                                            - WAITING_FOR_ULN_CONFIG
                                          - type: string
                                            enum:
                                            - FAILED
                                    - type: object
                                      properties:
                                        status:
                                          type: string
                                          enum:
                                          - WAITING
                                      required:
                                      - status
                                status:
                                  anyOf:
                                  - type: string
                                    enum:
                                    - WAITING
                                  - type: string
                                    enum:
                                    - QUORUM_REACHED
                                  - type: string
                                    enum:
                                    - SUCCEEDED
                            sealer:
                              type: object
                              properties:
                                tx:
                                  type: object
                                  properties:
                                    txHash:
                                      type: string
                                    blockHash:
                                      type: string
                                    blockNumber:
                                      type: number
                                    blockTimestamp:
                                      type: number
                                failedTx:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      txHash:
                                        type: string
                                      txError:
                                        type: string
                                status:
                                  anyOf:
                                  - type: string
                                    enum:
                                    - WAITING
                                  - type: string
                                    enum:
                                    - VALIDATING_TX
                                  - type: string
                                    enum:
                                    - SUCCEEDED
                                  - type: string
                                    enum:
                                    - FAILED
                        guid:
                          type: string
                        config:
                          type: object
                          properties:
                            error:
                              type: boolean
                            errorMessage:
                              type: string
                            dvnConfigError:
                              type: boolean
                            receiveLibrary:
                              type: string
                              nullable: true
                            sendLibrary:
                              type: string
                              nullable: true
                            inboundConfig:
                              anyOf:
                              - type: object
                                properties:
                                  confirmations:
                                    type: number
                                  requiredDVNCount:
                                    type: number
                                  optionalDVNCount:
                                    type: number
                                  optionalDVNThreshold:
                                    type: number
                                  requiredDVNs:
                                    type: array
                                    items:
                                      type: string
                                  requiredDVNNames:
                                    type: array
                                    items:
                                      type: string
                                  optionalDVNs:
                                    type: array
                                    items:
                                      type: string
                                  optionalDVNNames:
                                    type: array
                                    items:
                                      type: string
                                  executor:
                                    type: string
                              - type: object
                                properties:
                                  blockConfirmation:
                                    type: number
                                  relayerAddress:
                                    type: string
                                  oracleAddress:
                                    type: string
                                  executorAddress:
                                    type: string
                                  proofType:
                                    type: string
                                  utilsVersion:
                                    type: number
                                  proofVersion:
                                    type: string
                                    nullable: true
                                  proofLibraryAddress:
                                    type: string
                                    nullable: true
                                  ulnVersion:
                                    type: string
                                    enum:
                                    - V1
                                    - V2
                                    - V300
                                    - V301
                                    - V302
                                    - ReadV1002
                            outboundConfig:
                              anyOf:
                              - type: object
                                properties:
                                  confirmations:
                                    type: number
                                  requiredDVNCount:
                                    type: number
                                  optionalDVNCount:
                                    type: number
                                  optionalDVNThreshold:
                                    type: number
                                  requiredDVNs:
                                    type: array
                                    items:
                                      type: string
                                  requiredDVNNames:
                                    type: array
                                    items:
                                      type: string
                                  optionalDVNs:
                                    type: array
                                    items:
                                      type: string
                                  optionalDVNNames:
                                    type: array
                                    items:
                                      type: string
                                  executor:
                                    type: string
                              - type: object
                                properties:
                                  blockConfirmation:
                                    type: number
                                  relayerAddress:
                                    type: string
                                  oracleAddress:
                                    type: string
                                  executorAddress:
                                    type: string
                                  proofType:
                                    type: string
                            ulnSendVersion:
                              type: string
                              enum:
                              - V1
                              - V2
                              - V300
                              - V301
                              - V302
                              - ReadV1002
                            ulnReceiveVersion:
                              type: string
                              enum:
                              - V1
                              - V2
                              - V300
                              - V301
                              - V302
                              - ReadV1002
                        status:
                          type: object
                          properties:
                            name:
                              type: string
                              enum:
                              - INFLIGHT
                              - CONFIRMING
                              - FAILED
                              - DELIVERED
                              - BLOCKED
                              - PAYLOAD_STORED
                              - APPLICATION_BURNED
                              - APPLICATION_SKIPPED
                              - UNRESOLVABLE_COMMAND
                              - MALFORMED_COMMAND
                            message:
                              type: string
                        created:
                          type: string
                          default: '2025-05-27T19:20:54.364Z'
                        updated:
                          type: string
                          default: '2025-05-27T19:20:54.364Z'
                  nextToken:
                    type: string
                    description: The token to be passed for retrieving the next set of paginated results
                required:
                - data
  /messages/pathway/{pathwayId}:
    get:
      description: Get messages by pathway.
      tags:
      - messages
      parameters:
      - in: path
        name: pathwayId
        schema:
          type: string
          pattern: ^\d+-\d+-(?:[0-9A-Fa-f]+|[A-Z2-7]+|[1-9A-HJ-NP-Za-km-z]+|[A-Za-z0-9+/=]+)(?:-(?:[0-9A-Fa-f]+|[A-Z2-7]+|[1-9A-HJ-NP-Za-km-z]+|[A-Za-z0-9+/=]+))?$
          example: 30111-30101-0xf1fcb4cbd57b67d683972a59b6a7b1e2e8bf27e6-0x6d6620efa72948c5f68a3c8646d58c00d3f4a980
        required: true
      - in: query
        name: limit
        schema:
          anyOf:
          - type: number
          - type: string
          default: 100
      - in: query
        name: nonce
        schema:
          anyOf:
          - type: number
          - type: string
      - in: query
        name: status
        schema:
          type: string
          enum:
          - INFLIGHT
          - CONFIRMING
          - FAILED
          - DELIVERED
 

# --- truncated at 32 KB (215 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/layerzero/refs/heads/main/openapi/layerzero-messages-api-openapi.yml