---
updatedAt: 2025-06-25T21:55:25.000Z
agentTools:
  projectIndex: https://docs.nftgo.io/llms.txt
---

# Get Orders By Ids

Query the orders by specific orderIds

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "NFT Trading",
    "description": "",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "gem-fetcher/orderbook/v1/orders"
    }
  ],
  "paths": {
    "/orderbook/v1/orders/get-orders-by-ids": {
      "post": {
        "summary": "Get Orders By Ids",
        "x-apifox-folder": "gem-fetcher/orderbook/v1/orders",
        "x-apifox-status": "developing",
        "deprecated": false,
        "description": "Query the orders by specific orderIds",
        "tags": [
          "gem-fetcher/orderbook/v1/orders"
        ],
        "parameters": [
          {
            "name": "chain",
            "in": "query",
            "description": "Optional param for multi-chain.Default ethereum.",
            "required": false,
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Chain"
                }
              ],
              "description": "Optional param for multi-chain",
              "default": "ethereum"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "orders": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "order_id": {
                          "type": "string",
                          "title": "OrderId"
                        },
                        "order_type": {
                          "$ref": "#/components/schemas/OrderType",
                          "description": "The orderType of order, pass `listing` or `offer`"
                        }
                      },
                      "x-apifox-orders": [
                        "order_id",
                        "order_type"
                      ],
                      "required": [
                        "order_id",
                        "order_type"
                      ],
                      "x-apifox-ignore-properties": []
                    },
                    "maxItems": 50,
                    "title": "Specific orders to query"
                  }
                },
                "x-apifox-orders": [
                  "orders"
                ],
                "required": [
                  "orders"
                ],
                "x-apifox-ignore-properties": []
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "msg": {
                      "type": "string"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "listing_dtos": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ListingOrderDTO"
                          }
                        },
                        "offer_dtos": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/OfferDTO"
                          }
                        }
                      },
                      "x-apifox-orders": [
                        "listing_dtos",
                        "offer_dtos"
                      ],
                      "x-apifox-ignore-properties": []
                    }
                  },
                  "x-apifox-orders": [
                    "code",
                    "msg",
                    "data"
                  ],
                  "required": [
                    "code",
                    "msg",
                    "data"
                  ],
                  "x-apifox-ignore-properties": []
                }
              }
            }
          }
        },
        "x-run-in-apifox": "https://apifox.com/web/project/2272262/apis/api-102548687-run"
      }
    }
  },
  "components": {
    "schemas": {
      "OfferDTO": {
        "type": "object",
        "properties": {
          "order_id": {
            "type": "string",
            "description": "Unique orderId"
          },
          "order_hash": {
            "type": "string",
            "description": "Unique order hash"
          },
          "contract_address": {
            "type": "string",
            "description": "Offer associated NFT contract address"
          },
          "token_id": {
            "type": "string",
            "description": "Offer associated tokenId, only exists for token offer "
          },
          "criteria": {
            "type": "object",
            "properties": {},
            "description": "Describes the offer kind, this can be token, contract or trait offer.",
            "x-apifox-orders": [],
            "x-apifox-ignore-properties": []
          },
          "price": {
            "$ref": "#/components/schemas/TokenPrice",
            "description": "Offer price"
          },
          "fee_bps": {
            "type": "number"
          },
          "fee_breakdown": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FeeBreakdownItem"
            },
            "nullable": true
          },
          "market_id": {
            "$ref": "#/components/schemas/MarketId",
            "description": "The marketplace uniqueId that order belongs to"
          },
          "status": {
            "$ref": "#/components/schemas/OrderStatus",
            "description": "Offer's status"
          },
          "kind": {
            "$ref": "#/components/schemas/OrderKind",
            "description": "Offer's marketplace protocol"
          },
          "maker": {
            "type": "string",
            "description": "Offer's maker address"
          },
          "taker": {
            "type": "string",
            "description": "Offer's taker address, generally points to zero address implies any address can fulfill the offer"
          },
          "is_private": {
            "type": "boolean",
            "description": "False means order can be fulfilled by anyone"
          },
          "order_create_time": {
            "type": "number",
            "description": "Time that order is crreated"
          },
          "order_expiration_time": {
            "type": "number",
            "description": "Time that order will expire",
            "nullable": true
          },
          "quantity_remaining": {
            "type": "number",
            "description": "Number of tokens remaining for this offer"
          },
          "total_quantity": {
            "type": "number",
            "description": "Number of tokens when offer was created"
          },
          "on_chain_order_info": {
            "type": "string"
          }
        },
        "x-apifox-orders": [
          "order_id",
          "order_hash",
          "contract_address",
          "token_id",
          "criteria",
          "price",
          "fee_bps",
          "fee_breakdown",
          "market_id",
          "status",
          "kind",
          "maker",
          "taker",
          "is_private",
          "order_create_time",
          "order_expiration_time",
          "quantity_remaining",
          "total_quantity",
          "on_chain_order_info"
        ],
        "required": [
          "order_id",
          "maker",
          "kind",
          "status",
          "market_id",
          "price",
          "contract_address",
          "order_expiration_time",
          "order_create_time",
          "is_private",
          "taker",
          "total_quantity",
          "quantity_remaining",
          "criteria",
          "fee_bps",
          "fee_breakdown",
          "order_hash"
        ],
        "x-apifox-ignore-properties": [],
        "x-apifox-folder": "DTO"
      },
      "OrderKind": {
        "type": "string",
        "enum": [
          "seaport-v1.5",
          "blur",
          "looks-rare-v2",
          "x2y2",
          "payment-processor-v2"
        ],
        "x-apifox": {
          "enumDescriptions": {
            "seaport-v1.5": "",
            "blur": "",
            "looks-rare-v2": "",
            "x2y2": "",
            "payment-processor-v2": ""
          }
        },
        "x-apifox-folder": ""
      },
      "OrderStatus": {
        "type": "string",
        "enum": [
          "active",
          "inactive",
          "filled",
          "cancelled",
          "expired"
        ],
        "x-apifox": {
          "enumDescriptions": {
            "active": "",
            "inactive": "",
            "filled": "",
            "cancelled": "",
            "expired": ""
          }
        },
        "x-apifox-folder": ""
      },
      "MarketId": {
        "type": "string",
        "description": "The unique marketId for marketplace",
        "enum": [
          "opensea",
          "looksrare",
          "sudoswap",
          "x2y2",
          "blur",
          "artblocks",
          "reservoir",
          "ensvision",
          "magically",
          "alienswap",
          "ordinalsmarket",
          "sound"
        ],
        "x-apifox": {
          "enumDescriptions": {
            "opensea": "",
            "looksrare": "",
            "sudoswap": "",
            "x2y2": "",
            "blur": "",
            "artblocks": "",
            "reservoir": "",
            "ensvision": "",
            "magically": "",
            "alienswap": "",
            "ordinalsmarket": "",
            "sound": ""
          }
        },
        "x-apifox-folder": ""
      },
      "FeeBreakdownItem": {
        "type": "object",
        "properties": {
          "bps": {
            "type": "number"
          },
          "kind": {
            "type": "string",
            "enum": [
              "royalty",
              "marketplace"
            ],
            "x-apifox": {
              "enumDescriptions": {
                "royalty": "",
                "marketplace": ""
              }
            }
          },
          "recipient": {
            "type": "string"
          }
        },
        "x-apifox-orders": [
          "bps",
          "kind",
          "recipient"
        ],
        "required": [
          "bps",
          "kind",
          "recipient"
        ],
        "x-apifox-ignore-properties": [],
        "x-apifox-folder": ""
      },
      "TokenPrice": {
        "type": "object",
        "properties": {
          "currency": {
            "$ref": "#/components/schemas/TokenCurrency"
          },
          "amount": {
            "$ref": "#/components/schemas/TokenAmount"
          }
        },
        "x-apifox-orders": [
          "currency",
          "amount"
        ],
        "required": [
          "currency",
          "amount"
        ],
        "x-apifox-ignore-properties": [],
        "x-apifox-folder": ""
      },
      "TokenAmount": {
        "type": "object",
        "properties": {
          "raw": {
            "type": "string",
            "description": "Token amount in the smallest denomination"
          },
          "decimal": {
            "type": "number",
            "description": "Amount in decimal format"
          },
          "usd": {
            "type": "number",
            "description": "Amount in USD",
            "nullable": true
          },
          "platform": {
            "type": "number",
            "description": "Amount in plaftorm token.",
            "nullable": true
          }
        },
        "x-apifox-orders": [
          "raw",
          "decimal",
          "usd",
          "platform"
        ],
        "required": [
          "raw",
          "decimal",
          "usd",
          "platform"
        ],
        "x-apifox-ignore-properties": [],
        "x-apifox-folder": ""
      },
      "TokenCurrency": {
        "type": "object",
        "properties": {
          "chain": {
            "type": "string",
            "description": "Chain of the currency"
          },
          "contract_address": {
            "type": "string",
            "description": "Contract addresss of the currency"
          },
          "symbol": {
            "type": "string",
            "description": "Token symbol"
          },
          "decimals": {
            "type": "integer",
            "description": "The smallest denomination for the currency"
          }
        },
        "x-apifox-orders": [
          "chain",
          "contract_address",
          "symbol",
          "decimals"
        ],
        "required": [
          "chain",
          "contract_address",
          "symbol",
          "decimals"
        ],
        "x-apifox-ignore-properties": [],
        "x-apifox-folder": ""
      },
      "ListingOrderDTO": {
        "type": "object",
        "properties": {
          "order_id": {
            "type": "string",
            "description": "Unique orderId"
          },
          "order_hash": {
            "type": "string",
            "description": "Unique order hash"
          },
          "contract_address": {
            "type": "string",
            "description": "Listing associated NFT contract address"
          },
          "token_id": {
            "type": "string",
            "description": "Listing associated NFT token ID"
          },
          "price": {
            "$ref": "#/components/schemas/TokenPrice",
            "description": "Offer price"
          },
          "market_id": {
            "$ref": "#/components/schemas/MarketId",
            "description": "The marketplace uniqueId that order belongs to"
          },
          "kind": {
            "$ref": "#/components/schemas/OrderKind",
            "description": "Offer's marketplace protocol"
          },
          "status": {
            "$ref": "#/components/schemas/OrderStatus",
            "description": "Offer's status"
          },
          "maker": {
            "type": "string",
            "description": "Listing's maker address"
          },
          "taker": {
            "type": "string",
            "description": "Listing's taker address, generally points to zero address implies any address can fulfill the listing"
          },
          "is_private": {
            "type": "boolean",
            "description": "False means order can be fulfilled by anyone"
          },
          "quantity_remaining": {
            "type": "number",
            "description": "Number of tokens remaining for this listing"
          },
          "total_quantity": {
            "type": "number",
            "description": "Number of tokens when listing was created"
          },
          "order_create_time": {
            "type": "number",
            "description": "Time that order is crreated"
          },
          "order_expiration_time": {
            "type": "number",
            "description": "Time that order will expire"
          },
          "on_chain_order_info": {
            "type": "string"
          }
        },
        "x-apifox-orders": [
          "order_id",
          "order_hash",
          "contract_address",
          "token_id",
          "price",
          "market_id",
          "kind",
          "status",
          "maker",
          "taker",
          "is_private",
          "quantity_remaining",
          "total_quantity",
          "order_create_time",
          "order_expiration_time",
          "on_chain_order_info"
        ],
        "required": [
          "order_id",
          "contract_address",
          "token_id",
          "price",
          "market_id",
          "status",
          "maker",
          "taker",
          "total_quantity",
          "quantity_remaining",
          "is_private",
          "kind",
          "order_create_time",
          "order_expiration_time",
          "order_hash"
        ],
        "x-apifox-ignore-properties": [],
        "x-apifox-folder": "DTO"
      },
      "OrderType": {
        "type": "string",
        "enum": [
          "listing",
          "offer"
        ],
        "x-apifox": {
          "enumDescriptions": {
            "listing": "",
            "offer": ""
          }
        },
        "x-apifox-folder": ""
      },
      "Chain": {
        "type": "string",
        "enum": [
          "ethereum",
          "sepolia",
          "polygon"
        ],
        "x-apifox": {
          "enumDescriptions": {
            "ethereum": "",
            "sepolia": "",
            "polygon": ""
          }
        },
        "default": "ethereum"
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "servers": [
    {
      "url": "https://data-api.nftgo.io"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ]
}
```