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

# Get intent status using its receipt capability



## OpenAPI

````yaml /public/reference/openapi.json get /v1/intents/{hash}
openapi: 3.1.0
info:
  description: >-
    Public Tayho API for indexed protocol state, live calculations, relayed
    actions, and automatic-order lifecycle.
  title: Tayho API
  version: 1.0.0
servers:
  - description: Development
    url: https://api.testnet.tayho.io
security: []
tags:
  - name: System
  - name: Markets
  - name: Positions
  - name: Traders
  - name: Orders
  - name: Intents
  - name: Actions
  - name: Portfolio
  - name: Vault
  - name: Staking
  - name: Trading
  - name: Realtime
paths:
  /v1/intents/{hash}:
    get:
      tags:
        - Intents
      summary: Get intent status using its receipt capability
      operationId: getV1IntentsByHash
      parameters:
        - in: path
          name: hash
          required: true
          schema:
            examples:
              - >-
                0x2222222222222222222222222222222222222222222222222222222222222222
            pattern: ^0x[0-9a-fA-F]{64}$
            type: string
        - in: query
          name: receipt
          required: true
          schema:
            maxLength: 512
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1IntentsByHashResponse'
          description: Successful response.
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '422':
          $ref: '#/components/responses/Error422'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
        '502':
          $ref: '#/components/responses/Error502'
        '503':
          $ref: '#/components/responses/Error503'
        '504':
          $ref: '#/components/responses/Error504'
      security:
        - TayhoApiKey: []
components:
  schemas:
    GetV1IntentsByHashResponse:
      $ref: '#/components/schemas/IntentStatus'
    IntentStatus:
      additionalProperties: false
      properties:
        createdAt:
          $ref: '#/components/schemas/UnsignedIntegerString'
        failure:
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              const: false
          required:
            - code
            - message
            - retryable
          type: object
        order:
          $ref: '#/components/schemas/WireOrder'
        orderHash:
          $ref: '#/components/schemas/Hash'
        reservedTokens:
          $ref: '#/components/schemas/UnsignedIntegerString'
        settlement:
          additionalProperties: false
          properties:
            errorSelector:
              pattern: ^0x[0-9a-fA-F]{8}$
              type: string
            positionId:
              $ref: '#/components/schemas/UnsignedIntegerString'
            txHash:
              $ref: '#/components/schemas/Hash'
          required: []
          type: object
        state:
          type: string
        trigger:
          additionalProperties: false
          properties:
            blockHash:
              $ref: '#/components/schemas/Hash'
            blockNumber:
              $ref: '#/components/schemas/UnsignedIntegerString'
            priceWad:
              $ref: '#/components/schemas/UnsignedIntegerString'
          required:
            - priceWad
            - blockNumber
            - blockHash
          type: object
        updatedAt:
          $ref: '#/components/schemas/UnsignedIntegerString'
      required:
        - orderHash
        - state
        - createdAt
        - updatedAt
        - order
      type: object
    TayhoError:
      additionalProperties: true
      properties:
        code:
          type: string
        error:
          type: string
        requestId:
          pattern: ^[A-Za-z0-9._:-]{8,128}$
          type: string
      required:
        - error
      type: object
    UnsignedIntegerString:
      pattern: ^(?:0|[1-9][0-9]*)$
      type: string
    WireOrder:
      additionalProperties: false
      properties:
        closeMode:
          $ref: '#/components/schemas/UnsignedIntegerString'
        deadline:
          $ref: '#/components/schemas/UnsignedIntegerString'
        direction:
          $ref: '#/components/schemas/UnsignedIntegerString'
        limitPriceWad:
          $ref: '#/components/schemas/UnsignedIntegerString'
        marginTokens:
          $ref: '#/components/schemas/UnsignedIntegerString'
        marketId:
          $ref: '#/components/schemas/UnsignedIntegerString'
        nonce:
          $ref: '#/components/schemas/UnsignedIntegerString'
        ocoGroup:
          $ref: '#/components/schemas/Hash'
        orderType:
          $ref: '#/components/schemas/UnsignedIntegerString'
        positionId:
          $ref: '#/components/schemas/UnsignedIntegerString'
        qWad:
          $ref: '#/components/schemas/UnsignedIntegerString'
        sessionKey:
          $ref: '#/components/schemas/Address'
        trader:
          $ref: '#/components/schemas/Address'
        triggerPriceWad:
          $ref: '#/components/schemas/UnsignedIntegerString'
      required:
        - trader
        - sessionKey
        - nonce
        - deadline
        - orderType
        - marketId
        - direction
        - positionId
        - qWad
        - marginTokens
        - triggerPriceWad
        - limitPriceWad
        - closeMode
        - ocoGroup
      type: object
    Hash:
      pattern: ^0x[0-9a-fA-F]{64}$
      type: string
    Address:
      pattern: ^0x[0-9a-fA-F]{40}$
      type: string
  responses:
    Error401:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: Missing or invalid API key.
    Error403:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: The API key does not grant the required scope.
    Error404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: The requested resource does not exist.
    Error422:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: Request validation failed.
    Error429:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: The applicable request quota was exceeded.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            minimum: 1
            type: integer
    Error500:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: The request failed unexpectedly.
    Error502:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: A dependency returned an invalid or unsuccessful response.
    Error503:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: A required Tayho dependency is temporarily unavailable.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            minimum: 1
            type: integer
    Error504:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TayhoError'
      description: A required Tayho dependency timed out.
  securitySchemes:
    TayhoApiKey:
      description: Tayho project API key with the scope declared by the operation.
      in: header
      name: X-API-Key
      type: apiKey

````