Doma Protocol

https://docs.doma.xyz/
Admin
Doma Protocol transforms traditional domains into programmable, blockchain-based assets, enabling a...
Tokens:76,596
Snippets:367
Trust Score:7.2
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get All Available Registrars

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

Retrieves a list of all available registrars. This endpoint does not require any arguments.

```APIDOC
## GET /registrars

### Description
Get all available registrars.

### Method
GET

### Endpoint
/registrars

### Parameters
#### Query Parameters
*No query parameters*

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **RegistrarModel![]!** - A list of available registrars.

#### Response Example
```json
[
  {
    "ianaId": 1,
    "name": "Example Registrar"
  }
]
```
```

--------------------------------

### GET /fractionalTokenBalances

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

Fetches the balances of fractional tokens for specified wallet addresses. Supports pagination and filtering by fractional token ID.

```APIDOC
## GET /fractionalTokenBalances

### Description
Retrieves paginated balances of fractional tokens for specific wallets.

### Method
GET

### Endpoint
/fractionalTokenBalances

### Parameters
#### Query Parameters
- **skip** (Int) - Optional - Number of items to skip.
- **take** (Int) - Optional - Number of items to return in a current page.
- **fractionalTokenId** (Int) - Required - Fractional token id.
- **addresses** ([AddressCAIP10!]) - Required - Wallet addresses (chain-native format).

### Response
#### Success Response (200)
- **data** (PaginatedWalletBalanceResponse!) - The list of wallet balances and pagination information.

#### Response Example
```json
{
  "data": {
    "items": [
      {
        "fractionalTokenId": 1,
        "balance": "100",
        "address": "0x..."
      }
    ],
    "totalItems": 50,
    "currentPage": 1,
    "pageSize": 10
  }
}
```
```

--------------------------------

### GET /command

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

Retrieves information about a specific command using its correlation ID. Useful for tracking the status of client-initiated operations.

```APIDOC
## GET /command

### Description
Fetches information about a specific command by its correlation ID. Useful for tracking the status of client-initiated operations (e.g., bridging a name).

### Method
GET

### Endpoint
/command

### Parameters
#### Query Parameters
- **correlationId** (String!) - Required - Command correlation (relay) id to fetch information.

### Response
#### Success Response (200)
- **data** (CommandModel!) - The command information.

#### Response Example
```json
{
  "data": {
    "correlationId": "abc-123",
    "status": "COMPLETED",
    "createdAt": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### Fractionalization Buyout Price Time Data API

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

Retrieves daily buyout price data for a specific fractionalized name. Supports pagination and filtering by address, starting date, and aggregation interval.

```APIDOC
## GET /websites/doma_xyz/fractionalizationBuyoutPriceTimeData

### Description
Get daily buyout price data for a specific fractionalized name.

### Method
GET

### Endpoint
/websites/doma_xyz/fractionalizationBuyoutPriceTimeData

### Parameters
#### Query Parameters
- **skip** (Int) - Optional - Number of items to skip.
- **take** (Int) - Optional - Number of items to return in a current page.
- **address** (AddressCAIP10!) - Required - Fractional token address (CAIP-10 format).
- **startingDate** (DateTime!) - Required - Starting date for the aggregation period.
- **interval** (AggregatePeriod!) - Required - Aggregation period (DAY or HOUR).

### Response
#### Success Response (200)
- **response** ([BuyoutPriceTimeData!]!) - An array of buyout price time data.

#### Response Example
```json
[
  {
    "timestamp": "2023-10-27T12:00:00Z",
    "buyoutPrice": "950000000000000000"
  },
  {
    "timestamp": "2023-10-27T13:00:00Z",
    "buyoutPrice": "960000000000000000"
  }
]
```
```

--------------------------------

### GET /tokenActivities

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

Retrieves a paginated list of activities related to a specific token. Supports extensive filtering and sorting options.

```APIDOC
## GET /tokenActivities

### Description
Retrieves a paginated list of activities related to a specific token. Supports extensive filtering and sorting options.

### Method
GET

### Endpoint
/tokenActivities

### Parameters
#### Query Parameters
- **skip** (Int) - Optional - Number of items to skip.
- **take** (Int) - Optional - Number of items to return in a current page.
- **sortOrder** (SortOrderType) - Optional - Sort order for results.
- **tokenId** (String) - Optional - Token ID to query activities for.
- **types** ([TokenActivityType!]) - Optional - Filter by activity types.
- **wallets** (TokenActivitiesWalletsInput) - Optional - Role-specific wallet filters; addresses apply only to relevant roles/types.
- **sortBy** (TokenActivitiesSortBy) - Optional - Field to sort token activities by.
- **tlds** ([String!]) - Optional - Filter activities by TLDs.
- **priceMinUsd** (Float) - Optional - Filter activities by minimum USD price.
- **priceMaxUsd** (Float) - Optional - Filter activities by maximum USD price.
- **fromDate** (DateTime) - Optional - Filter activities created on or after this date (inclusive).
- **toDate** (DateTime) - Optional - Filter activities created on or before this date (inclusive).

### Response
#### Success Response (200)
- **data** (PaginatedTokenActivitiesResponse!) - The list of token activities and pagination information.

#### Response Example
```json
{
  "data": {
    "items": [
      {
        "id": 1,
        "tokenId": "token-123",
        "type": "SALE",
        "timestamp": "2023-10-27T10:00:00Z",
        "priceUsd": 100.50
      }
    ],
    "totalItems": 500,
    "currentPage": 1,
    "pageSize": 10
  }
}
```
```

--------------------------------

### GET /fractionalTokens

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

Retrieves a list of all fractional tokens. Supports pagination and filtering by name, wallet addresses, status, and network IDs.

```APIDOC
## GET /fractionalTokens

### Description
Retrieves a paginated list of fractional tokens with optional filtering capabilities.

### Method
GET

### Endpoint
/fractionalTokens

### Parameters
#### Query Parameters
- **skip** (Int) - Optional - Number of items to skip.
- **take** (Int) - Optional - Number of items to return in a current page.
- **sortOrder** (SortOrderType) - Optional - Sort order for results.
- **name** (String) - Optional - Filter by domain name.
- **walletAddresses** ([AddressCAIP10!]) - Optional - Filter by wallet addresses (CAIP-10 format).
- **status** (FractionalTokenStatus) - Optional - Filter by fractional token status.
- **networkIds** ([String!]) - Optional - Filter by network IDs in CAIP-2 format.

### Response
#### Success Response (200)
- **data** (PaginatedFractionalTokenInfoResponse!) - The list of fractional tokens and pagination information.

#### Response Example
```json
{
  "data": {
    "items": [
      {
        "id": 1,
        "name": "example.com",
        "status": "ACTIVE",
        "networkId": "eip155:1",
        "ownerAddress": "0x..."
      }
    ],
    "totalItems": 100,
    "currentPage": 1,
    "pageSize": 10
  }
}
```
```

--------------------------------

### Get Contract Version (Solidity)

Source: https://docs.doma.xyz/api-reference/doma-smart-contracts-api/evm-proxy-doma-record-api

Returns the current version string of the smart contract. This is a pure function and does not modify the contract state.

```solidity
function version() external pure returns (string)
```

--------------------------------

### Get Supported Currencies

Source: https://docs.doma.xyz/api-reference/orderbook-api

Retrieves a list of all supported currency tokens for orderbook operations on a specified chain. This endpoint requires authentication with an API Key.

```APIDOC
## GET /v1/orderbook/currencies/{chainId}/{contractAddress}/{orderbook}

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

### Method
GET

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

### Parameters
#### Path Parameters
- **chainId** (string) - Required - The chain ID in CAIP-2 format
- **contractAddress** (string) - Required - The contract address of the token.
- **orderbook** (string) - Required - The name of the orderbook.

### Request Example
```json
{
  "example": "No request body for this GET request."
}
```

### Response
#### Success Response (200)
- **currencies** (array) - List of supported currency tokens for orderbook operations.
  - **contractAddress** (object) - Token contract address.
  - **name** (string) - Token name.
  - **symbol** (string) - Currency symbol.
  - **decimals** (number) - Number of decimal places for the token.
  - **type** (string) - Indicates what operations this currency supports. (ENUM: LISTING_ONLY, OFFER_ONLY, ALL)
  - **nativeWrapper** (boolean) - Indicates if this currency is a wrapper token (e.g., WETH).
  - **usdExchangeRate** (number) - USD exchange rate for the currency.

#### Response Example
```json
{
  "currencies": [
    {
      "contractAddress": {
        "address": "0x1234567890abcdef1234567890abcdef12345678"
      },
      "name": "Ether",
      "symbol": "ETH",
      "decimals": 18,
      "type": "ALL",
      "nativeWrapper": false,
      "usdExchangeRate": 3000.50
    }
  ]
}
```

#### Error Responses
- **400** - Bad Request. Invalid chain ID format.
- **401** - Unauthorized. API Key is missing or invalid.
- **403** - Forbidden. API Key is missing 'ORDERBOOK' permission.
```

--------------------------------

### Apply to Launch Waitlist

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

Adds a wallet address to the launch waitlist for a specific name token.

```APIDOC
## POST /launchWaitlistApply

### Description
Add a wallet address to the launch waitlist for a specific name token.

### Method
POST

### Endpoint
/launchWaitlistApply

### Parameters
#### Request Body
- **walletAddress** (String) - Required - Wallet address to add to the waitlist (CAIP-10 format).
- **tokenId** (String) - Required - Name token ID for the waitlist.

### Request Example
```json
{
  "walletAddress": "eip155:1:0x1234567890abcdef1234567890abcdef12345678",
  "tokenId": "example.com"
}
```

### Response
#### Success Response (200)
- **LaunchWaitlistEntryModel** - The created waitlist entry.

#### Response Example
```json
{
  "id": "waitlist_entry_1",
  "walletAddress": "eip155:1:0x1234567890abcdef1234567890abcdef12345678",
  "tokenId": "example.com",
  "appliedAt": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

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

Source: https://docs.doma.xyz/api-reference/orderbook-api

Get paginated items for a bulk listing by bulk listing ID. This endpoint retrieves a list of items associated with a specific bulk listing, allowing for efficient management and tracking.

```APIDOC
## GET /v1/orderbook/list/bulk/{id}/items

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

### Method
GET

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

### Parameters
#### Path Parameters
- **id** (string) - Required - Bulk listing ID

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **PaginatedBulkListingResponse** (object) - Bulk listing items retrieved successfully.
  - **items** (array) - Response items.
  - **totalCount** (number) - Total number of items.
  - **pageSize** (number) - Number of items per page.
  - **currentPage** (number) - Current page.
  - **totalPages** (number) - Total of pages.
  - **hasPreviousPage** (boolean) - Has previous page.
  - **hasNextPage** (boolean) - Has next page.

#### Response Example
```json
{
  "items": [
    "item1",
    "item2"
  ],
  "totalCount": 100,
  "pageSize": 10,
  "currentPage": 1,
  "totalPages": 10,
  "hasPreviousPage": false,
  "hasNextPage": true
}
```

#### Error Response (400)
Bad Request. Bulk listing not found or invalid parameters.

#### Error Response (403)
Forbidden. API Key is missing 'ORDERBOOK' permission.
```

--------------------------------

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

Source: https://docs.doma.xyz/api-reference/orderbook-api

Retrieves offer fulfillment data for a specific order ID and fulfiller address. This endpoint is used to get the necessary details to fulfill an offer, including order parameters and signature.

```APIDOC
## GET /v1/orderbook/offer/{orderId}/{fulfiller}

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

### Method
GET

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

### Parameters
#### Path Parameters
- **orderId** (string) - Required - The Order ID of the offer.
- **fulfiller** (string) - Required - Fulfiller address, in native chain format. This is the address that owns the name token.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **order** (object) - Order containing parameters and signature.
  - **parameters** (object) - Order parameters.
    - **offerer** (string) - Address of the offerer.
    - **zone** (string) - Zone address.
    - **orderType** (number) - Type of order. Enum: [0, 1, 2, 3].
    - **startTime** (string) - Start time of the order (Unix timestamp as string).
    - **endTime** (string) - End time of the order (Unix timestamp as string).
    - **zoneHash** (string) - Zone hash.
    - **salt** (string) - Salt for the order.
    - **offer** (array) - Array of offer items.
      - **itemType** (number) - The type of item being offered. Enum: [0, 1, 2, 3, 4, 5].
      - **token** (string) - Token address of the item being offered.
      - **identifierOrCriteria** (string) - Identifier or criteria for the item.
      - **startAmount** (string) - Starting amount for the item.
      - **endAmount** (string) - Ending amount for the item.
    - **consideration** (array) - Array of consideration items. Considerations must include following fee items: Doma Marketplace fee, Name Token Royalties, OpenSea Fees (only for OpenSea Orderbook).
      - **itemType** (number) - The type of item being offered. Enum: [0, 1, 2, 3, 4, 5].
      - **token** (string) - Token address of the item being offered.
      - **identifierOrCriteria** (string) - Identifier or criteria for the item.
      - **startAmount** (string) - Starting amount for the item.
      - **endAmount** (string) - Ending amount for the item.
      - **recipient** (string) - Recipient address to receive the consideration item.
    - **totalOriginalConsiderationItems** (number) - Total number of original consideration items.
    - **conduitKey** (string) - Conduit key.
    - **counter** (string) - Counter for the order (as string).
  - **signature** (string) - Order signature.
- **extraData** (object) - Extra data for seaport fulfilment.

#### Response Example
```json
{
  "order": {
    "parameters": {
      "offerer": "0x...",
      "zone": "0x...",
      "orderType": 0,
      "startTime": "1678886400",
      "endTime": "1678886400",
      "zoneHash": "0x...",
      "salt": "0x...",
      "offer": [
        {
          "itemType": 0,
          "token": "0x...",
          "identifierOrCriteria": "123",
          "startAmount": "1",
          "endAmount": "1"
        }
      ],
      "consideration": [
        {
          "itemType": 0,
          "token": "0x...",
          "identifierOrCriteria": "123",
          "startAmount": "1",
          "endAmount": "1",
          "recipient": "0x..."
        }
      ],
      "totalOriginalConsiderationItems": 1,
      "conduitKey": "0x...",
      "counter": "0"
    },
    "signature": "0x..."
  },
  "extraData": {}
}
```

#### Error Responses
- **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

Source: https://docs.doma.xyz/api-reference/orderbook-api

Creates multiple fixed-price listings on supported orderbooks like Doma and OpenSea.

```APIDOC
## POST /v1/orderbook/list/bulk

### Description
Creates multiple fixed priced listings on a supported orderbook (Doma and OpenSea).

### Method
POST

### Endpoint
/v1/orderbook/list/bulk

### Parameters
#### Query Parameters
None

#### Request Body
- **tokenId** (string) - Required - The ID of the token to list.
- **contract** (string) - Required - The contract address of the token.
- **error** (string) - Required - Description of the error.

### Request Example
```json
{
  "listings": [
    {
      "tokenId": "123",
      "contract": "0xabc...",
      "price": "1.0",
      "currency": "ETH"
    },
    {
      "tokenId": "456",
      "contract": "0xdef...",
      "price": "2.5",
      "currency": "ETH"
    }
  ]
}
```

### Response
#### Success Response (200)
- **createdListings** (array) - A list of successfully created listings.
- **failedListings** (array) - A list of listings that failed to be created, with error details.

#### Response Example
```json
{
  "createdListings": [
    {
      "orderId": "order123",
      "tokenId": "123",
      "contract": "0xabc..."
    }
  ],
  "failedListings": [
    {
      "tokenId": "456",
      "contract": "0xdef...",
      "error": "Insufficient balance"
    }
  ]
}
```

#### Error Responses
- **400 Bad Request**: Invalid query parameters.
- **401 Unauthorized**: API Key is missing or invalid.
- **403 Forbidden**: API Key is missing 'ORDERBOOK' permission.
```

--------------------------------

### POST /offers

Source: https://docs.doma.xyz/api-reference/orderbook-api

Creates multiple fixed-price offers on a supported orderbook (Doma and OpenSea). This endpoint allows for batch creation of offers, with options to cancel existing offers and provide cancellation signatures if necessary.

```APIDOC
## POST /offers

### Description
Creates multiple fixed priced offers on a supported orderbook (Doma and OpenSea).

### Method
POST

### Endpoint
/offers

### Parameters
#### Query Parameters
None

#### Request Body
- **orderbook** (string) - Required - Orderbook identifier. Only DOMA is supported.
- **chainId** (string) - Required - Chain ID in CAIP-2 format.
- **orders** (array) - Required - Array of orders to create. Maximum 50 orders allowed.
  - **parameters** (object) - Required - Order parameters.
    - **offerer** (string) - Required - Address of the offerer.
    - **zone** (string) - Required - Zone address.
    - **orderType** (number) - Required - Type of order.
    - **startTime** (string) - Required - Start time of the order (Unix timestamp as string).
    - **endTime** (string) - Required - End time of the order (Unix timestamp as string).
    - **zoneHash** (string) - Required - Zone hash.
    - **salt** (string) - Required - Salt for the order.
    - **offer** (array) - Required - Array of offer items.
      - **itemType** (number) - Required - The type of item being offered.
      - **token** (string) - Required - Token address of the item being offered.
      - **identifierOrCriteria** (string) - Required - Identifier or criteria for the item.
      - **startAmount** (string) - Required - Starting amount for the item.
      - **endAmount** (string) - Required - Ending amount for the item.
    - **consideration** (array) - Required - Array of consideration items. Considerations must include following fee items: Doma Marketplace fee, Name Token Royalties, OpenSea Fees (only for OpenSea Orderbook).
      - **itemType** (number) - Required - The type of item being offered.
      - **token** (string) - Required - Token address of the item being offered.
      - **identifierOrCriteria** (string) - Required - Identifier or criteria for the item.
      - **startAmount** (string) - Required - Starting amount for the item.
      - **endAmount** (string) - Required - Ending amount for the item.
      - **recipient** (string) - Required - Recipient address to receive the consideration item.
    - **totalOriginalConsiderationItems** (number) - Required - Total number of original consideration items.
    - **conduitKey** (string) - Required - Conduit key.
    - **counter** (string) - Required - Counter for the order (as string).
  - **signature** (string) - Required - Order signature.
- **cancelExisting** (boolean) - Optional - Cancel existing orders if they exist.
- **cancelSignatures** (object) - Optional - Map of order IDs to cancellation signatures. Required for OpenSea orderbook when canceling existing orders.

### Request Example
```json
{
  "orderbook": "DOMA",
  "chainId": "eip155:1",
  "orders": [
    {
      "parameters": {
        "offerer": "0x...",
        "zone": "0x...",
        "orderType": 0,
        "startTime": "1678886400",
        "endTime": "1678886400",
        "zoneHash": "0x...",
        "salt": "0x...",
        "offer": [
          {
            "itemType": 2,
            "token": "0x...",
            "identifierOrCriteria": "123",
            "startAmount": "1",
            "endAmount": "1"
          }
        ],
        "consideration": [
          {
            "itemType": 0,
            "token": "0x...",
            "identifierOrCriteria": "0",
            "startAmount": "1",
            "endAmount": "1",
            "recipient": "0x..."
          }
        ],
        "totalOriginalConsiderationItems": 1,
        "conduitKey": "0x...",
        "counter": "0"
      },
      "signature": "0x..."
    }
  ],
  "cancelExisting": false
}
```

### Response
#### Success Response (200)
- **orders** (array) - Array of created listing responses.
  - **orderId** (string) - The unique identifier for the created order.
  - **orderData** (object) - Order data.
  - **signature** (string) - Order signature.
- **errors** (array) - Array of error messages.
  - **tokenId** (string) - Token ID of name that failed
  - **contract** (string) - Contract address of name that failed
  - **error** (string) - Error message

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "0x...",
      "orderData": {
        "offerer": "0x...",
        "zone": "0x...",
        "orderType": 0,
        "startTime": "1678886400",
        "endTime": "1678886400",
        "zoneHash": "0x...",
        "salt": "0x...",
        "offer": [
          {
            "itemType": 2,
            "token": "0x...",
            "identifierOrCriteria": "123",
            "startAmount": "1",
            "endAmount": "1"
          }
        ],
        "consideration": [
          {
            "itemType": 0,
            "token": "0x...",
            "identifierOrCriteria": "0",
            "startAmount": "1",
            "endAmount": "1",
            "recipient": "0x..."
          }
        ],
        "totalOriginalConsiderationItems": 1,
        "conduitKey": "0x...",
        "counter": "0"
      },
      "signature": "0x..."
    }
  ],
  "errors": []
}
```
```

--------------------------------

### Get Registries by Owner

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

Retrieves a list of registries that have active domains, with an option to filter by owner addresses.

```APIDOC
## GET /registries

### Description
Get all registries that have active domains. Can be filtered by owner addresses.

### Method
GET

### Endpoint
/registries

### Parameters
#### Query Parameters
- **ownedBy** (Array<String>) - Optional - Filter by owner addresses (CAIP-10 format).

### Request Example
```
GET /registries?ownedBy=eip155:1:0x1234567890abcdef1234567890abcdef12345678
```

### Response
#### Success Response (200)
- **RegistryModel![]!** - A list of registries with active domains.

#### Response Example
```json
[
  {
    "id": "example.com",
    "name": "Example Registry"
  }
]
```
```

--------------------------------

### Create Bulk Listings

Source: https://docs.doma.xyz/api-reference/orderbook-api

Allows the creation of multiple fixed-price listings on supported orderbooks like Doma and OpenSea.

```APIDOC
## POST /api/v1/orders/bulk

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

### Method
POST

### Endpoint
`/api/v1/orders/bulk`

### Parameters
#### Request Body
- **orderbook** (string) - Required - Orderbook identifier. Only DOMA is supported.
- **chainId** (string) - Required - Chain ID in CAIP-2 format.
- **orders** (array) - Required - Array of orders to create. Maximum 50 orders allowed.
  - **parameters** (object) - Required - Order parameters.
    - **offerer** (string) - Required - Address of the offerer.
    - **zone** (string) - Required - Zone address.
    - **orderType** (number) - Required - Type of order.
    - **startTime** (string) - Required - Start time of the order (Unix timestamp as string).
    - **endTime** (string) - Required - End time of the order (Unix timestamp as string).
    - **zoneHash** (string) - Required - Zone hash.
    - **salt** (string) - Required - Salt for the order.
    - **offer** (array) - Required - Array of offer items.
      - **itemType** (number) - Required - The type of item being offered.
      - **token** (string) - Required - Token address of the item being offered.
      - **identifierOrCriteria** (string) - Required - Identifier or criteria for the item.
      - **startAmount** (string) - Required - Starting amount for the item.
      - **endAmount** (string) - Required - Ending amount for the item.
    - **consideration** (array) - Required - Array of consideration items. Considerations must include following fee items: Doma Marketplace fee, Name Token Royalties, OpenSea Fees (only for OpenSea Orderbook).
      - **itemType** (number) - Required - The type of item being offered.
      - **token** (string) - Required - Token address of the item being offered.
      - **identifierOrCriteria** (string) - Required - Identifier or criteria for the item.
      - **startAmount** (string) - Required - Starting amount for the item.
      - **endAmount** (string) - Required - Ending amount for the item.
      - **recipient** (string) - Required - Recipient address to receive the consideration item.
    - **totalOriginalConsiderationItems** (number) - Required - Total number of original consideration items.
    - **conduitKey** (string) - Required - Conduit key.
    - **counter** (string) - Required - Counter for the order (as string).
  - **signature** (string) - Required - Order signature.
- **cancelExisting** (boolean) - Optional - Cancel existing orders if they exist.
- **cancelSignatures** (object) - Optional - Map of order IDs to cancellation signatures. Required for OpenSea orderbook when canceling existing orders.

### Request Example
```json
{
  "orderbook": "DOMA",
  "chainId": "eip155:1",
  "orders": [
    {
      "parameters": {
        "offerer": "0xabc123",
        "zone": "0x0000000000000000000000000000000000000000",
        "orderType": 0,
        "startTime": "1678886400",
        "endTime": "1678886400",
        "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "salt": "0x12345",
        "offer": [
          {
            "itemType": 2,
            "token": "0x123",
            "identifierOrCriteria": "1",
            "startAmount": "1",
            "endAmount": "1"
          }
        ],
        "consideration": [
          {
            "itemType": 0,
            "token": "0x123",
            "identifierOrCriteria": "0",
            "startAmount": "1",
            "endAmount": "1",
            "recipient": "0xabc123"
          }
        ],
        "totalOriginalConsiderationItems": 1,
        "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "counter": "0"
      },
      "signature": "0xabcdef12345"
    }
  ],
  "cancelExisting": false
}
```

### Response
#### Success Response (200)
- **orders** (array) - Array of created listing responses.
  - **orderId** (string) - The unique identifier for the created order.
  - **orderData** (object) - Order data.
  - **signature** (string) - Order signature.
- **errors** (array) - Array of error messages.
  - **tokenId** (string) - Token ID of name that failed
  - **contract** (string) - Contract address of name that failed
  - **error** (string) - Error message

#### Response Example
```json
{
  "orders": [
    {
      "orderId": "0x123456789",
      "orderData": {
        "offerer": "0xabc123",
        "zone": "0x0000000000000000000000000000000000000000",
        "orderType": 0,
        "startTime": "1678886400",
        "endTime": "1678886400",
        "zoneHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "salt": "0x12345",
        "offer": [
          {
            "itemType": 2,
            "token": "0x123",
            "identifierOrCriteria": "1",
            "startAmount": "1",
            "endAmount": "1"
          }
        ],
        "consideration": [
          {
            "itemType": 0,
            "token": "0x123",
            "identifierOrCriteria": "0",
            "startAmount": "1",
            "endAmount": "1",
            "recipient": "0xabc123"
          }
        ],
        "totalOriginalConsiderationItems": 1,
        "conduitKey": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "counter": "0"
      },
      "signature": "0xabcdef12345"
    }
  ],
  "errors": []
}
```
```

--------------------------------

### POST fractionalizationGenerateMetadata

Source: https://docs.doma.xyz/api-reference/doma-multi-chain-subgraph

This endpoint creates metadata in JSON format and uploads an image file. It's used for generating token descriptions and associated image uploads.

```APIDOC
## POST /websites/doma_xyz/fractionalizationGenerateMetadata

### Description
This endpoint is used to generate metadata for token descriptions and upload an associated image file. The metadata includes details such as title, description, and links.

### Method
POST

### Endpoint
/websites/doma_xyz/fractionalizationGenerateMetadata

### Parameters
#### Request Body
- **title** (String) - Required - Token description title
- **description** (String) - Required - Token description
- **xLink** (String) - Required - X (Twitter) link.
- **primaryWebsite** (String) - Required - Primary website URL.
- **additionalWebsites** ([WebsiteInput!]) - Required - Additional websites.
- **image** (Upload!) - Required - Image file to upload.

### Request Example
{
  "title": "My Token",
  "description": "This is a token description",
  "xLink": "https://twitter.com/example",
  "primaryWebsite": "https://example.com",
  "additionalWebsites": [{"url": "https://anotherexample.com"}],
  "image": "[File Upload]"
}

### Response
#### Success Response (200)
- **GeneratedMetadataResponse!** - Metadata generation response.

#### Response Example
{
  "example": "Generated metadata response"
}
```

--------------------------------

### Get Offer Fulfillment Data (OpenAPI Specification)

Source: https://docs.doma.xyz/api-reference/orderbook-api

This OpenAPI 3.0 specification defines the 'Get Offer fulfillment data' endpoint. It allows retrieval of offer fulfillment details by order ID and fulfiller address, returning a JSON object with order parameters and extra data for Seaport fulfillment. Dependencies include the API key for authentication.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Doma Registrar API",
    "version": "1.0"
  },
  "servers": [
    "https://api.doma.xyz",
    "https://api-testnet.doma.xyz"
  ],
  "security": [
    {
      "Api-Key": []
    }
  ],
  "components": {
    "securitySchemes": {
      "Api-Key": {
        "type": "apiKey",
        "in": "header",
        "name": "Api-Key"
      }
    },
    "schemas": {
      "GetOrderByIdResponse": {
        "type": "object",
        "properties": {
          "order": {
            "description": "Order containing parameters and signature.",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderResponse"
              }
            ]
          },
          "extraData": {
            "type": "object",
            "description": "Extra data for seaport fulfilment."
          }
        },
        "required": [
          "order"
        ]
      },
      "OrderResponse": {
        "type": "object",
        "properties": {
          "parameters": {
            "description": "Order parameters.",
            "allOf": [
              {
                "$ref": "#/components/schemas/OrderComponents"
              }
            ]
          },
          "signature": {
            "type": "string",
            "description": "Order signature."
          }
        },
        "required": [
          "parameters",
          "signature"
        ]
      },
      "OrderComponents": {
        "type": "object",
        "properties": {
          "offerer": {
            "type": "string",
            "description": "Address of the offerer."
          },
          "zone": {
            "type": "string",
            "description": "Zone address."
          },
          "orderType": {
            "type": "number",
            "description": "Type of order.",
            "enum": [
              0,
              1,
              2,
              3
            ]
          },
          "startTime": {
            "type": "string",
            "description": "Start time of the order (Unix timestamp as string)."
          },
          "endTime": {
            "type": "string",
            "description": "End time of the order (Unix timestamp as string)."
          },
          "zoneHash": {
            "type": "string",
            "description": "Zone hash."
          },
          "salt": {
            "type": "string",
            "description": "Salt for the order."
          },
          "offer": {
            "description": "Array of offer items.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OfferItem"
            }
          },
          "consideration": {
            "description": "Array of consideration items. Considerations must include following fee items: Doma Marketplace fee, Name Token Royalties, OpenSea Fees (only for OpenSea Orderbook).",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConsiderationItem"
            }
          },
          "totalOriginalConsiderationItems": {
            "type": "number",
            "description": "Total number of original consideration items."
          },
          "conduitKey": {
            "type": "string",
            "description": "Conduit key."
          },
          "counter": {
            "type": "string",
            "description": "Counter for the order (as string)."
          }
        },
        "required": [
          "offerer",
          "zone",
          "orderType",
          "startTime",
          "endTime",
          "zoneHash",
          "salt",
          "offer",
          "consideration",
          "totalOriginalConsiderationItems",
          "conduitKey",
          "counter"
        ]
      },
      "OfferItem": {
        "type": "object",
        "properties": {
          "itemType": {
            "type": "number",
            "description": "The type of item being offered.",
            "enum": [
              0,
              1,
              2,
              3,
              4,
              5
            ]
          },
          "token": {
            "type": "string",
            "description": "Token address of the item being offered."
          },
          "identifierOrCriteria": {
            "type": "string",
            "description": "Identifier or criteria for the item."
          },
          "startAmount": {
            "type": "string",
            "description": "Starting amount for the item."
          },
          "endAmount": {
            "type": "string",
            "description": "Ending amount for the item."
          }
        },
        "required": [
          "itemType",
          "token",
          "identifierOrCriteria",
          "startAmount",
          "endAmount"
        ]
      },
      "ConsiderationItem": {
        "type": "object",
        "properties": {
          "itemType": {
            "type": "number",
            "description": "The type of item being offered.",
            "enum": [
              0,
              1,
              2,
              3,
              4,
              5
            ]
          },
          "token": {
            "type": "string",
            "description": "Token address of the item being offered."
          },
          "identifierOrCriteria": {
            "type": "string",
            "description": "Identifier or criteria for the item."
          },
          "startAmount": {
            "type": "string",
            "description": "Starting amount for the item."
          },
          "endAmount": {
            "type": "string",
            "description": "Ending amount for the item."
          },
          "recipient": {
            "type": "string",
            "description": "Recipient address to receive the consideration item."
          }
        },
        "required": [
          "itemType",
          "token",
          "identifierOrCriteria",
          "startAmount",
          "endAmount",
          "recipient"
        ]
      }
    }
  },
  "paths": {
    "/v1/orderbook/offer/{orderId}/{fulfiller}": {
      "get": {
        "description": "Get offer fulfillment data by order id and fulfiller (token owner) address.",
        "operationId": "OrderbookApiController_getOfferById",
        "parameters": [
          {
            "name": "orderId",
            "required": true,
            "in": "path",
            "description": "The Order ID of the offer.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fulfiller",
            "required": true,
            "in": "path",
            "description": "Fulfiller address, in native chain format. This is the address that owns the name token.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetOrderByIdResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. Invalid query parameters."
          },
          "401": {
            "description": "Unauthorized. API Key is missing or invalid."
          },
          "403": {
            "description": "Forbidden. API Key is missing 'ORDERBOOK' permission."
          }
        },
        "summary": "Get Offer fulfillment data",
        "tags": [
          "Orderbook API"
        ]
      }
    }
  }
}

```
Tokens:
Raw