Orderbook API | Doma Documentation

Create Listing

post

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

Authorizations

Body

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

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

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

{
  "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"
}

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

Create Offer

post

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

Authorizations

Body

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

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

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

{
  "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"
}

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

Get Listing fulfillment data

get

Get listing fulfillment data by order id and buyer address.

Authorizations

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

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

{
  "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"
}

Get Offer fulfillment data

get

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

Authorizations

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

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

{
  "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"
}

Cancel Listing

post

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

Authorizations

Body

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

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

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

Authorizations

Body

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

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 orderbook fees

get

Get marketplace fees for a specific orderbook and chain.

Authorizations

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

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

{
  "marketplaceFees": [
    []
  ]
}

Get supported currencies

get

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

Authorizations

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

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

{
  "currencies": [
    []
  ]
}