Orderbook API

Create Listing

post

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/list

Create a fixed priced listing on a supported orderbook (OpenSea, Doma).

Authorizations

Api-Key

Api-KeystringRequired

Body

application/json

orderbookstringRequired

Orderbook identifier.

Example: OPENSEA or DOMA

chainIdstringRequired

Chain ID in CAIP-2 format.

Example: eip155:1Pattern: ^[a-z0-9]+:[a-zA-Z0-9]+$

parametersall ofRequired

Order parameters.

signaturestringRequired

Order signature.

Example: 0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

cancelExistingbooleanRequired

Cancel existing order if it exists.

Example: true

Responses

200Success

application/json

400

Bad Request. Invalid query parameters.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

post

/v1/orderbook/list

HTTPcURLJavaScriptPython

POST /v1/orderbook/list HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 727

{
  "orderbook": "OPENSEA or DOMA",
  "chainId": "eip155:1",
  "parameters": {
    "offerer": "0x1234567890123456789012345678901234567890",
    "zone": "0x1234567890123456789012345678901234567890",
    "orderType": 0,
    "startTime": "1714931840",
    "endTime": "1717523840",
    "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "salt": "0x00000000000000000000000000000000000000000000000012aca0ba7ced6d0b",
    "offer": [
      []
    ],
    "consideration": [
      []
    ],
    "totalOriginalConsiderationItems": 2,
    "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "counter": "0"
  },
  "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890",
  "cancelExisting": true
}

{
  "orderId": "3434-3675-5844-7264",
  "orderData": {
    "offerer": "0x1234567890123456789012345678901234567890",
    "zone": "0x1234567890123456789012345678901234567890",
    "orderType": 0,
    "startTime": "1714931840",
    "endTime": "1717523840",
    "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "salt": "0x00000000000000000000000000000000000000000000000012aca0ba7ced6d0b",
    "offer": [
      []
    ],
    "consideration": [
      []
    ],
    "totalOriginalConsiderationItems": 2,
    "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "counter": "0"
  },
  "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
}

Create Offer

post

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/offer

Create an offer on a supported orderbook (OpenSea, Doma).

Authorizations

Api-Key

Api-KeystringRequired

Body

application/json

orderbookstringRequired

Orderbook identifier.

Example: OPENSEA or DOMA

chainIdstringRequired

Chain ID in CAIP-2 format.

Example: eip155:1Pattern: ^[a-z0-9]+:[a-zA-Z0-9]+$

parametersall ofRequired

Order parameters.

signaturestringRequired

Order signature.

Example: 0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

cancelExistingbooleanRequired

Cancel existing order if it exists.

Example: true

Responses

200Success

application/json

400

Bad Request. Invalid query parameters.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

post

/v1/orderbook/offer

HTTPcURLJavaScriptPython

POST /v1/orderbook/offer HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 727

{
  "orderbook": "OPENSEA or DOMA",
  "chainId": "eip155:1",
  "parameters": {
    "offerer": "0x1234567890123456789012345678901234567890",
    "zone": "0x1234567890123456789012345678901234567890",
    "orderType": 0,
    "startTime": "1714931840",
    "endTime": "1717523840",
    "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "salt": "0x00000000000000000000000000000000000000000000000012aca0ba7ced6d0b",
    "offer": [
      []
    ],
    "consideration": [
      []
    ],
    "totalOriginalConsiderationItems": 2,
    "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "counter": "0"
  },
  "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890",
  "cancelExisting": true
}

{
  "orderId": "3434-3675-5844-7264",
  "orderData": {
    "offerer": "0x1234567890123456789012345678901234567890",
    "zone": "0x1234567890123456789012345678901234567890",
    "orderType": 0,
    "startTime": "1714931840",
    "endTime": "1717523840",
    "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "salt": "0x00000000000000000000000000000000000000000000000012aca0ba7ced6d0b",
    "offer": [
      []
    ],
    "consideration": [
      []
    ],
    "totalOriginalConsiderationItems": 2,
    "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "counter": "0"
  },
  "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
}

Get orderbook fees

get

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/fee/{orderbook}/{chainId}/{contractAddress}

Get marketplace fees for a specific orderbook and chain.

Authorizations

Api-Key

Api-KeystringRequired

Path parameters

orderbookstringRequired

The orderbook type

chainIdstringRequired

The chain ID in CAIP-2 format

contractAddressstringRequired

The contract address of the token being listed or offered.

Responses

200Success

application/json

400

Bad Request. Invalid path parameters.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

get

/v1/orderbook/fee/{orderbook}/{chainId}/{contractAddress}

HTTPcURLJavaScriptPython

GET /v1/orderbook/fee/{orderbook}/{chainId}/{contractAddress} HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Accept: */*

{
  "marketplaceFees": [
    []
  ]
}

Get Listing fulfillment data

get

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/listing/{orderId}/{buyer}

Get listing fulfillment data by order id and buyer address.

Authorizations

Api-Key

Api-KeystringRequired

Path parameters

orderIdstringRequired

The Order ID of the listing.

buyerstringRequired

Buyer address, in native chain format.

Example: 0x1234567890123456789012345678901234567890

Responses

200Success

application/json

400

Bad Request. Invalid query parameters.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

get

/v1/orderbook/listing/{orderId}/{buyer}

HTTPcURLJavaScriptPython

GET /v1/orderbook/listing/{orderId}/{buyer} HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Accept: */*

{
  "order": {
    "parameters": {
      "offerer": "0x1234567890123456789012345678901234567890",
      "zone": "0x1234567890123456789012345678901234567890",
      "orderType": 0,
      "startTime": "1714931840",
      "endTime": "1717523840",
      "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "salt": "0x00000000000000000000000000000000000000000000000012aca0ba7ced6d0b",
      "offer": [
        []
      ],
      "consideration": [
        []
      ],
      "totalOriginalConsiderationItems": 2,
      "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "counter": "0"
    },
    "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
  },
  "extraData": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
}

Get Offer fulfillment data

get

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/offer/{orderId}/{fulfiller}

Get offer fulfillment data by order id and fulfiller (token owner) address.

Authorizations

Api-Key

Api-KeystringRequired

Path parameters

orderIdstringRequired

The Order ID of the offer.

fulfillerstringRequired

Fulfiller address, in native chain format. This is the address that owns the name token.

Example: 0x1234567890123456789012345678901234567890

Responses

200Success

application/json

400

Bad Request. Invalid query parameters.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

get

/v1/orderbook/offer/{orderId}/{fulfiller}

HTTPcURLJavaScriptPython

GET /v1/orderbook/offer/{orderId}/{fulfiller} HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Accept: */*

{
  "order": {
    "parameters": {
      "offerer": "0x1234567890123456789012345678901234567890",
      "zone": "0x1234567890123456789012345678901234567890",
      "orderType": 0,
      "startTime": "1714931840",
      "endTime": "1717523840",
      "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "salt": "0x00000000000000000000000000000000000000000000000012aca0ba7ced6d0b",
      "offer": [
        []
      ],
      "consideration": [
        []
      ],
      "totalOriginalConsiderationItems": 2,
      "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "counter": "0"
    },
    "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
  },
  "extraData": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
}

Cancel Listing

post

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/listing/cancel

Cancel a listing on a supported orderbook (OpenSea, Doma).

Authorizations

Api-Key

Api-KeystringRequired

Body

application/json

orderIdstringRequired

The Order ID to cancel.

Example: 3434-3675-5844-7264

signaturestringRequired

EIP-712 signature for cancel authorization.

Example: 0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

Responses

200Success

application/json

400

Bad Request. Invalid signature or order not found.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

post

/v1/orderbook/listing/cancel

HTTPcURLJavaScriptPython

POST /v1/orderbook/listing/cancel HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "orderId": "3434-3675-5844-7264",
  "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
}

{
  "orderId": "3434-3675-5844-7264"
}

Cancel Offer

post

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/offer/cancel

Cancel an offer on a supported orderbook (OpenSea, Doma).

Authorizations

Api-Key

Api-KeystringRequired

Body

application/json

orderIdstringRequired

The Order ID to cancel.

Example: 3434-3675-5844-7264

signaturestringRequired

EIP-712 signature for cancel authorization.

Example: 0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

Responses

200Success

application/json

400

Bad Request. Invalid signature or order not found.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

post

/v1/orderbook/offer/cancel

HTTPcURLJavaScriptPython

POST /v1/orderbook/offer/cancel HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "orderId": "3434-3675-5844-7264",
  "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
}

{
  "orderId": "3434-3675-5844-7264"
}

Get supported currencies

get

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/currencies/{chainId}/{contractAddress}/{orderbook}

Get all supported currency tokens for orderbook operations on a specific chain.

Authorizations

Api-Key

Api-KeystringRequired

Path parameters

chainIdstringRequired

The chain ID in CAIP-2 format

Example: eip155:1

contractAddressstringRequired

The contract address of the token.

Example: 0x1234567890123456789012345678901234567890

orderbookstringRequired

The name of the orderbook.

Example: OpenSea

Responses

200Success

application/json

400

Bad Request. Invalid chain ID format.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

get

/v1/orderbook/currencies/{chainId}/{contractAddress}/{orderbook}

HTTPcURLJavaScriptPython

GET /v1/orderbook/currencies/{chainId}/{contractAddress}/{orderbook} HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Accept: */*

{
  "currencies": [
    []
  ]
}

Create Bulk Listings

post

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/list/bulk

Create multiple fixed priced listings on a supported orderbook (Doma and OpenSea).

Authorizations

Api-Key

Api-KeystringRequired

Body

application/json

orderbookstring · enumRequired

Orderbook identifier. Only DOMA is supported.

Example: DOMAPossible values:

chainIdstringRequired

Chain ID in CAIP-2 format.

Example: eip155:1Pattern: ^[a-z0-9]+:[a-zA-Z0-9]+$

cancelExistingbooleanRequired

Cancel existing orders if they exist.

Example: true

Responses

200Success

application/json

400

Bad Request. Invalid query parameters.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

post

/v1/orderbook/list/bulk

HTTPcURLJavaScriptPython

POST /v1/orderbook/list/bulk HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "orderbook": "DOMA",
  "chainId": "eip155:1",
  "orders": [
    []
  ],
  "cancelExisting": true
}

{
  "orders": [
    {
      "orderId": "3434-3675-5844-7264",
      "orderData": {
        "offerer": "0x1234567890123456789012345678901234567890",
        "zone": "0x1234567890123456789012345678901234567890",
        "orderType": 0,
        "startTime": "1714931840",
        "endTime": "1717523840",
        "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "salt": "0x00000000000000000000000000000000000000000000000012aca0ba7ced6d0b",
        "offer": [
          []
        ],
        "consideration": [
          []
        ],
        "totalOriginalConsiderationItems": 2,
        "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "counter": "0"
      },
      "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
    }
  ],
  "errors": [
    {
      "tokenId": "text",
      "contract": "text",
      "error": "text"
    }
  ]
}

Create Bulk Offers

post

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/offer/bulk

Create multiple fixed priced offers on a supported orderbook (Doma and OpenSea).

Authorizations

Api-Key

Api-KeystringRequired

Body

application/json

orderbookstring · enumRequired

Orderbook identifier. Only DOMA is supported.

Example: DOMAPossible values:

chainIdstringRequired

Chain ID in CAIP-2 format.

Example: eip155:1Pattern: ^[a-z0-9]+:[a-zA-Z0-9]+$

cancelExistingbooleanRequired

Cancel existing orders if they exist.

Example: true

Responses

200Success

application/json

400

Bad Request. Invalid query parameters.

401

Unauthorized. API Key is missing or invalid.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

post

/v1/orderbook/offer/bulk

HTTPcURLJavaScriptPython

POST /v1/orderbook/offer/bulk HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "orderbook": "DOMA",
  "chainId": "eip155:1",
  "orders": [
    []
  ],
  "cancelExisting": true
}

{
  "orders": [
    {
      "orderId": "3434-3675-5844-7264",
      "orderData": {
        "offerer": "0x1234567890123456789012345678901234567890",
        "zone": "0x1234567890123456789012345678901234567890",
        "orderType": 0,
        "startTime": "1714931840",
        "endTime": "1717523840",
        "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "salt": "0x00000000000000000000000000000000000000000000000012aca0ba7ced6d0b",
        "offer": [
          []
        ],
        "consideration": [
          []
        ],
        "totalOriginalConsiderationItems": 2,
        "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "counter": "0"
      },
      "signature": "0x1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890"
    }
  ],
  "errors": [
    {
      "tokenId": "text",
      "contract": "text",
      "error": "text"
    }
  ]
}

Get bulk listing items

get

https://api-testnet.doma.xyzhttps://api.doma.xyz

/v1/orderbook/list/bulk/{id}/items

Get paginated items for a bulk listing by bulk listing ID.

Authorizations

Api-Key

Api-KeystringRequired

Path parameters

idstringRequired

Bulk listing ID

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Bulk listing items retrieved successfully

application/json

400

Bad Request. Bulk listing not found or invalid parameters.

403

Forbidden. API Key is missing 'ORDERBOOK' permission.

get

/v1/orderbook/list/bulk/{id}/items

HTTPcURLJavaScriptPython

GET /v1/orderbook/list/bulk/{id}/items HTTP/1.1
Host: api-testnet.doma.xyz
Api-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    "text"
  ],
  "totalCount": 100,
  "pageSize": 20,
  "currentPage": 10,
  "totalPages": 100,
  "hasPreviousPage": true,
  "hasNextPage": true
}