CoW Swap App Data API

openapi: 3.2.0
info:
  version: 0.0.1
  title: Order Book App Data API
servers:
- description: Mainnet (Prod)
  url: https://api.cow.fi/mainnet
- description: Mainnet (Staging)
  url: https://barn.api.cow.fi/mainnet
- description: Gnosis Chain (Prod)
  url: https://api.cow.fi/xdai
- description: Gnosis Chain (Staging)
  url: https://barn.api.cow.fi/xdai
- description: Arbitrum One (Prod)
  url: https://api.cow.fi/arbitrum_one
- description: Arbitrum One (Staging)
  url: https://barn.api.cow.fi/arbitrum_one
- description: Base (Prod)
  url: https://api.cow.fi/base
- description: Base (Staging)
  url: https://barn.api.cow.fi/base
- description: Avalanche (Prod)
  url: https://api.cow.fi/avalanche
- description: Avalanche (Staging)
  url: https://barn.api.cow.fi/avalanche
- description: Polygon (Prod)
  url: https://api.cow.fi/polygon
- description: Polygon (Staging)
  url: https://barn.api.cow.fi/polygon
- description: Linea (Prod)
  url: https://api.cow.fi/linea
- description: Linea (Staging)
  url: https://barn.api.cow.fi/linea
- description: BNB (Prod)
  url: https://api.cow.fi/bnb
- description: BNB (Staging)
  url: https://barn.api.cow.fi/bnb
- description: Plasma (Prod)
  url: https://api.cow.fi/plasma
- description: Plasma (Staging)
  url: https://barn.api.cow.fi/plasma
- description: Ink (Prod)
  url: https://api.cow.fi/ink
- description: Ink (Staging)
  url: https://barn.api.cow.fi/ink
- description: Sepolia (Prod)
  url: https://api.cow.fi/sepolia
- description: Sepolia (Staging)
  url: https://barn.api.cow.fi/sepolia
- description: Local
  url: http://localhost:8080
tags:
- name: App Data
paths:
  /api/v1/app_data/{app_data_hash}:
    get:
      operationId: getAppDataByHash
      summary: Get the full `appData` from contract `appDataHash`
      parameters:
      - in: path
        name: app_data_hash
        schema:
          $ref: '#/components/schemas/AppDataHash'
        required: true
      responses:
        '200':
          description: Full `appData`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDataObject'
        '400':
          description: Invalid app data hash.
        '404':
          description: No full `appData` stored for this hash.
      tags:
      - App Data
    put:
      operationId: registerAppDataByHash
      summary: Registers a full `appData` so it can be referenced by `appDataHash`
      description: Uploads a full `appData` to orderbook so that orders created with the corresponding `appDataHash` can be linked to the original full `appData`.
      parameters:
      - in: path
        name: app_data_hash
        schema:
          $ref: '#/components/schemas/AppDataHash'
        required: true
      requestBody:
        description: The `appData` document to upload.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppDataObject'
      responses:
        '200':
          description: The full `appData` already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDataHash'
        '201':
          description: The full `appData` was successfully registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDataHash'
        '400':
          description: Error validating full `appData`
        '422':
          description: Unable to parse request body as valid JSON.
        '500':
          description: Error storing the full `appData`
      tags:
      - App Data
  /api/v1/app_data:
    put:
      operationId: registerAppData
      summary: Registers a full `appData` and returns `appDataHash`
      description: Uploads a full `appData` to orderbook and returns the corresponding `appDataHash`.
      requestBody:
        description: The `appData` document to upload.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppDataObject'
      responses:
        '200':
          description: The full `appData` already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDataHash'
        '201':
          description: The full `appData` was successfully registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDataHash'
        '400':
          description: Error validating full `appData`
        '422':
          description: Unable to parse request body as valid JSON.
        '500':
          description: Error storing the full `appData`
      tags:
      - App Data
components:
  schemas:
    AppDataObject:
      description: An `appData` document that is registered with the API.
      type: object
      properties:
        fullAppData:
          $ref: '#/components/schemas/AppData'
      required:
      - fullAppData
    AppData:
      description: 'The string encoding of a JSON object representing some `appData`. The

        format of the JSON expected in the `appData` field is defined

        [here](https://github.com/cowprotocol/app-data).

        '
      type: string
      example: '{"version":"0.9.0","metadata":{}}'
    AppDataHash:
      description: '32 bytes encoded as hex with `0x` prefix.

        It''s expected to be the hash of the stringified JSON object representing the `appData`.

        '
      type: string
      example: '0x0000000000000000000000000000000000000000000000000000000000000000'