Skip to main content
POST
/
v1
/
chains
/
{chain_name}
/
orders
/
metadata-bids
Create a metadata bid
curl --request POST \
  --url https://api.sandbox.immutable.com/v1/chains/{chain_name}/orders/metadata-bids \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
  "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770",
  "metadata_id": "018792C9-4AD7-8EC4-4038-9E05C598534B",
  "sell": [
    {
      "type": "ERC20",
      "amount": "9750000000000000000",
      "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F"
    }
  ],
  "fees": [
    {
      "type": "MAKER_ECOSYSTEM",
      "amount": "2250000000000000000",
      "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233"
    }
  ],
  "end_at": "2022-03-10T05:00:50.52Z",
  "protocol_data": {
    "order_type": "FULL_RESTRICTED",
    "counter": "1",
    "zone_address": "0x12",
    "seaport_address": "0x12",
    "seaport_version": "1.5"
  },
  "salt": "12686911856931635052326433555881236148",
  "buy": [
    {
      "type": "ERC721_COLLECTION",
      "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E",
      "amount": "1"
    }
  ],
  "signature": "0x",
  "start_at": "2022-03-09T05:00:50.52Z"
}
'
{
  "result": {
    "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
    "sell": [
      {
        "type": "ERC20",
        "amount": "9750000000000000000",
        "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F"
      }
    ],
    "fees": [],
    "chain": {
      "id": "eip155:11155111",
      "name": "sepolia"
    },
    "metadata_id": "018792C9-4AD7-8EC4-4038-9E05C598534B",
    "created_at": "2022-03-07T07:20:50.52Z",
    "end_at": "2022-03-10T05:00:50.52Z",
    "id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
    "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
    "protocol_data": {
      "order_type": "PARTIAL_RESTRICTED",
      "counter": "1",
      "zone_address": "0x12",
      "seaport_address": "0x12",
      "seaport_version": "1.5"
    },
    "salt": "12686911856931635052326433555881236148",
    "buy": [
      {
        "type": "ERC721_COLLECTION",
        "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E",
        "amount": "1"
      }
    ],
    "signature": "0x",
    "start_at": "2022-03-09T05:00:50.52Z",
    "status": {
      "name": "EXPIRED"
    },
    "type": "METADATA_BID",
    "updated_at": "2022-03-07T07:20:50.52Z"
  }
}

Path Parameters

​
chain_name
string
required

The name of chain

Example:

"imtbl-zkevm-testnet"

Body

application/json

Request body for creating a metadata bid. Exactly one of metadata_id or metadata_criteria must be provided.

​
account_address
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"

​
order_hash
string
required
Example:

"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"

​
buy
object[]
required

Buy item for metadata bid should either be ERC721 or ERC1155 collection item

Required array length: 1 element
Example:
[
  {
    "type": "ERC721_COLLECTION",
    "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E",
    "amount": "1"
  }
]
​
fees
object[]
required

Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.

Maximum array length: 2
Example:
[]
​
end_at
string<date-time>
required

Time after which the Order is considered expired

Example:

"2022-03-09T05:00:50.52Z"

​
protocol_data
object
required
Example:
{
  "order_type": "FULL_RESTRICTED",
  "counter": "92315562",
  "zone_address": "0x12",
  "seaport_address": "0x12",
  "seaport_version": "1.5"
}
​
salt
string
required

A random value added to the create Order request

Example:

"12686911856931635052326433555881236148"

​
sell
object[]
required

Sell item for metadata bid should be an ERC20 item

Required array length: 1 element
Example:
[
  {
    "type": "ERC20",
    "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E",
    "amount": "9750000000000000000"
  }
]
​
signature
string
required

Digital signature generated by the user for the specific Order

Example:

"0x"

​
start_at
string<date-time>
required

Time after which Order is considered active

Example:

"2022-03-09T05:00:50.52Z"

​
metadata_id
string<uuid>

Metadata identifier that matching NFTs must have to fulfill this bid. Mutually exclusive with metadata_criteria.

Example:

"018792C9-4AD7-8EC4-4038-9E05C598534B"

​
metadata_criteria
object[]

Field-level metadata filters that matching NFTs must satisfy to fulfill this bid. Mutually exclusive with metadata_id.

Minimum array length: 1
Example:
[
  {
    "field_name": "name",
    "values": ["Cool Dragon"]
  },
  {
    "field_name": "attribute:Background",
    "values": ["Blue", "Red"]
  }
]

Response

Created response.

​
result
object
required
Example:
{
  "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
  "buy": [
    {
      "type": "NATIVE",
      "amount": "9750000000000000000",
      "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F"
    }
  ],
  "fees": [],
  "chain": {
    "id": "eip155:11155111",
    "name": "sepolia"
  },
  "created_at": "2022-03-07T07:20:50.52Z",
  "end_at": "2022-03-10T05:00:50.52Z",
  "id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
  "protocol_data": {
    "order_type": "FULL_RESTRICTED",
    "counter": "1",
    "zone_address": "0x12",
    "seaport_address": "0x12",
    "seaport_version": "1.4"
  },
  "salt": "12686911856931635052326433555881236148",
  "sell": [
    {
      "type": "ERC721",
      "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E",
      "token_id": "1"
    }
  ],
  "signature": "0x",
  "start_at": "2022-03-09T05:00:50.52Z",
  "status": { "name": "ACTIVE" },
  "fill_status": { "numerator": 1, "denominator": 2 },
  "type": "LISTING",
  "updated_at": "2022-03-07T07:20:50.52Z"
}