Everclear

Everclear Batched Intents API

The Batched Intents API from Everclear — 2 operation(s) for batched intents.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.everclear.org/developers/api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/connext/refs/heads/main/authentication/connext-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/connext/refs/heads/main/openapi/connext-batched-intents-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/connext/refs/heads/main/errors/connext-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/connext/refs/heads/main/conventions/connext-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/connext/refs/heads/main/data-model/connext-data-model.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/connext/refs/heads/main/apis.yml

OpenAPI Specification

connext-batched-intents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Chimera Batched Intents API
  version: 1.0.0
servers:
- url: https://api.testnet.everclear.org
- url: https://api.everclear.org
tags:
- name: Batched Intents
paths:
  /batched-intents:
    get:
      summary: Get intents
      description: Retrieves a paginated list of intents based on query parameters
      parameters:
      - in: query
        name: cursor
        required: false
        schema:
          type: string
      - in: query
        name: prevCursor
        required: false
        schema:
          type: string
      - in: query
        name: limit
        required: false
        schema:
          type: integer
        default: 10
      - in: query
        name: statuses
        required: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: origins
        required: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: destinations
        required: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: allDestinations
        required: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: txHash
        required: false
        schema:
          type: string
      - in: query
        name: userAddress
        required: false
        schema:
          type: string
      - in: query
        name: startDate
        required: false
        schema:
          type: string
      - in: query
        name: endDate
        required: false
        schema:
          type: string
      - in: query
        name: tickerHash
        required: false
        schema:
          type: string
      - in: query
        name: isFastPath
        required: false
        schema:
          type: boolean
        description: Filter for fast path intents (intents with TTL > 0)
      responses:
        '200':
          description: Successful retrieval of intents
          content:
            application/json:
              schema:
                type: object
                required:
                - items
                - nextCursor
                properties:
                  items:
                    type: array
                    items:
                      anyOf:
                      - type: object
                        required:
                        - type
                        - batchId
                        - intents
                        - token_fee
                        - native_fee
                        properties:
                          type:
                            type: string
                            enum:
                            - batch
                          batchId:
                            type: string
                          token_fee:
                            type: string
                          native_fee:
                            type: string
                          intents:
                            type: array
                            items:
                              $ref: '#/components/schemas/Intent'
                      - type: object
                        required:
                        - type
                        - intent
                        properties:
                          type:
                            type: string
                            enum:
                            - intent
                          intent:
                            $ref: '#/components/schemas/Intent'
                  nextCursor:
                    type:
                    - string
                    - 'null'
                    required: true
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
      tags:
      - Batched Intents
  /batched-intents/{batchId}:
    get:
      summary: Get batched intents
      description: Retrieves a list of intents for a given batch ID
      parameters:
      - in: path
        name: batchId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of intents
          content:
            application/json:
              schema:
                type: object
                required:
                - batchId
                - intents
                - token_fee
                - native_fee
                properties:
                  batchId:
                    type: string
                  token_fee:
                    type: string
                  native_fee:
                    type: string
                  intents:
                    type: array
                    items:
                      $ref: '#/components/schemas/Intent'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
      tags:
      - Batched Intents
components:
  schemas:
    IntentStatus:
      type: string
      enum:
      - NONE
      - ADDED
      - ADDED_SPOKE
      - ADDED_HUB
      - DEPOSIT_PROCESSED
      - FILLED
      - ADDED_AND_FILLED
      - INVOICED
      - SETTLED
      - SETTLED_AND_COMPLETED
      - SETTLED_AND_MANUALLY_EXECUTED
      - UNSUPPORTED
      - UNSUPPORTED_RETURNED
      - DISPATCHED_HUB
      - DISPATCHED_SPOKE
      - DISPATCHED_UNSUPPORTED
    Intent:
      type: object
      properties:
        intent_id:
          type: string
          description: A string representing the intent ID
        batch_id:
          type:
          - string
          - 'null'
          description: A string representing the batch ID
        queue_idx:
          type: integer
          format: int64
          description: Queue index
        message_id:
          type: string
          description: A string representing the message ID
        status:
          $ref: '#/components/schemas/IntentStatus'
          description: The status of the intent
        receiver:
          type: string
          description: Receiver address
        input_asset:
          type: string
          description: Input asset
        output_asset:
          type: string
          description: Output asset
        origin_amount:
          type: string
          description: Origin amount
        destination_amount:
          type:
          - string
          - 'null'
          description: Destination amount
        origin:
          type: string
          description: Origin address
        destinations:
          type: array
          items:
            type: string
            description: Destination address
        nonce:
          type: integer
          format: int64
          description: Nonce
        transaction_hash:
          type: string
          description: Transaction hash (intent_created tx hash)
        receive_tx_hash:
          type:
          - string
          - 'null'
          description: Receive transaction hash
        intent_created_timestamp:
          type: integer
          format: int64
          description: Intent Created timestamp
        settlement_timestamp:
          type:
          - integer
          - 'null'
          format: int64
          description: Receive timestamp
        intent_created_block_number:
          type: integer
          format: int64
          description: Intent created block number
        receive_blocknumber:
          type:
          - integer
          - 'null'
          format: int64
          description: Receive block number
        tx_origin:
          type: string
          description: Transaction origin address
        tx_nonce:
          type: integer
          format: int64
          description: Transaction nonce
        auto_id:
          type: integer
          format: int64
          description: Auto-generated identifier
        amount_out_min:
          type: string
          description: amount_out_min used in intent
        call_data:
          type:
          - string
          - 'null'
          description: Call data
        filled:
          type:
          - boolean
          - 'null'
          description: Filler address
        initiator:
          type:
          - string
          - 'null'
          description: Initiator address
        native_fee:
          type:
          - string
          - 'null'
          description: Native fee
        token_fee:
          type:
          - string
          - 'null'
          description: Token fee
        fee_adapter_initiator:
          type:
          - string
          - 'null'
          description: Fee adapter initiator address
        origin_gas_fees:
          type: string
          description: Origin gas fees
        destination_gas_fees:
          type:
          - string
          - 'null'
          description: Destination gas fees
        hub_settlement_domain:
          type:
          - string
          - 'null'
          description: Settlement domain for an intent
        ttl:
          type:
          - number
          - 'null'
          description: TTL set for an intent
        is_fast_path:
          type: boolean
          description: Is the intent for fast path service
        fill_solver:
          type:
          - string
          - 'null'
          description: Solver/filler address on destination domain
        fill_domain:
          type:
          - string
          - 'null'
          description: Destination domain that was actually filled
        fill_destinations:
          type:
          - array
          - 'null'
          items:
            type: string
          description: All destination domains from the destination leg
        fill_transaction_hash:
          type:
          - string
          - 'null'
          description: Destination chain transaction hash for fill
        fill_timestamp:
          type:
          - integer
          - 'null'
          format: int64
          description: Timestamp when destination was filled
        fill_amount:
          type:
          - string
          - 'null'
          description: Amount filled on destination chain (raw units)
        fill_fee_token:
          type:
          - string
          - 'null'
          description: Fee charged on destination chain in token terms
        fill_fee_dbps:
          type:
          - string
          - 'null'
          description: Fee charged on destination chain in dbps
        fill_input_asset:
          type:
          - string
          - 'null'
          description: Input asset used on destination chain
        fill_output_asset:
          type:
          - string
          - 'null'
          description: Output asset received on destination chain
        fill_sender:
          type:
          - string
          - 'null'
          description: EOA/contract that submitted destination tx
        fill_status:
          type:
          - string
          - 'null'
          description: Status of the destination leg
        fill_initiator:
          type:
          - string
          - 'null'
          description: Initiator for the destination leg
        fill_receiver:
          type:
          - string
          - 'null'
          description: Receiver for the destination leg
        max_fee:
          type: string
          description: Max Fee for intent in V1 system (defaulted to 0 in new system)
      required:
      - intent_id
      - queue_idx
      - message_id
      - status
      - receiver
      - input_asset
      - output_asset
      - origin_amount
      - origin
      - destinations
      - nonce
      - data
      - transaction_hash
      - intent_created_timestamp
      - intent_created_block_number
      - tx_origin
      - tx_nonce
      - auto_id
      - amount_out_min
      - origin_gas_fees
      - ttl