diff --git a/packages/internal/generated-clients/src/mr-openapi.json b/packages/internal/generated-clients/src/mr-openapi.json index 38ac124226..23262726e3 100644 --- a/packages/internal/generated-clients/src/mr-openapi.json +++ b/packages/internal/generated-clients/src/mr-openapi.json @@ -2278,95 +2278,6 @@ } } }, - "/v1/internal/chains/{chain_name}/environment/{environment}/collections/{contract_address}/refresh-metadata": { - "post": { - "description": "Refresh collection metadata internal", - "summary": "Refresh collection metadata internal", - "tags": [ - "collections" - ], - "operationId": "RefreshCollectionMetadataInternal", - "security": [ - { - "BearerAuthWithClient": [] - } - ], - "parameters": [ - { - "name": "contract_address", - "in": "path", - "description": "The address contract", - "required": true, - "schema": { - "type": "string" - }, - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - { - "name": "chain_name", - "description": "The name of chain", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/ChainName" - }, - "examples": { - "testnet": { - "value": "imtbl-zkevm-testnet", - "summary": "Immutable zkEVM Public Testnet" - } - } - }, - { - "name": "environment", - "in": "path", - "description": "The environment of the collection", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RefreshCollectionMetadataRequest" - } - } - } - }, - "responses": { - "200": { - "description": "200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RefreshCollectionMetadataResult" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/UnauthorisedRequest" - }, - "403": { - "$ref": "#/components/responses/ForbiddenRequest" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "500": { - "$ref": "#/components/responses/InternalServerError" - } - } - } - }, "/v1/chains/{chain_name}/orders/cancel": { "post": { "tags": [ @@ -4221,36 +4132,49 @@ } } }, - "/passport-mr/v1/wallets/{wallet_address}/user": { - "get": { + "/v2/chains/{chain_name}/passport/counterfactual-address": { + "post": { "x-internal": true, - "summary": "Get user for a wallet", - "description": "Get the user associated with a wallet address", + "summary": "Create a counterfactual address v2", + "description": "Create a counterfactual address for a user based on their Ethereum address", "tags": [ "passport" ], + "operationId": "createCounterfactualAddressV2", + "security": [ + { + "BearerAuth": [ + "transact" + ] + } + ], "parameters": [ { - "name": "wallet_address", + "name": "chain_name", "in": "path", - "description": "The wallet address", "required": true, "schema": { - "type": "string", - "pattern": "^0x[0-9a-fA-F]{40}$", - "maxLength": 42 + "$ref": "#/components/schemas/ChainName" } } ], - "operationId": "getUserForWallet", - "security": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCounterfactualAddressRequest" + } + } + } + }, "responses": { - "200": { - "description": "Wallet user response", + "201": { + "description": "Counterfactual address created response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletUserRes" + "$ref": "#/components/schemas/CreateCounterfactualAddressRes" } } } @@ -4285,12 +4209,12 @@ } } }, - "404": { - "description": "NotFoundError", + "409": { + "description": "ConflictError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError404" + "$ref": "#/components/schemas/APIError409" } } } @@ -4328,35 +4252,48 @@ } } }, - "/passport-mr/v1/users/{email_address}/wallet": { + "/v1/chains/{chain_name}/passport/users/{user_id}/linked-addresses": { "get": { - "x-internal": true, - "summary": "Get wallet for a user", - "description": "Get the wallet address associated with a user's email", + "deprecated": true, + "summary": "Get Ethereum linked addresses for a user", + "description": "This API has been deprecated, please use https://docs.immutable.com/zkevm/api/reference/#/operations/getUserInfo instead to get a list of linked addresses.", "tags": [ "passport" ], "parameters": [ { - "name": "email_address", + "name": "user_id", + "in": "path", + "description": "The user's userId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "chain_name", "in": "path", - "description": "The user's email address", "required": true, "schema": { - "type": "string", - "format": "email" + "$ref": "#/components/schemas/ChainName" } } ], - "operationId": "getWalletForUser", - "security": [], + "operationId": "getLinkedAddresses", + "security": [ + { + "BearerAuth": [ + "openid" + ] + } + ], "responses": { "200": { - "description": "User wallet response", + "description": "User's list of linked addresses response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetUserWalletRes" + "$ref": "#/components/schemas/GetLinkedAddressesRes" } } } @@ -4391,16 +4328,6 @@ } } }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, "429": { "description": "TooManyRequestsError", "content": { @@ -4434,40 +4361,49 @@ } } }, - "/passport-mr/v1/users/delete": { + "/v1/chains/{chain_name}/passport/transaction-metadata": { "post": { "x-internal": true, - "summary": "Delete user's Passport account", - "description": "Delete user's Passport account", + "summary": "Get transaction metadata", + "description": "Get transaction metadata for a given encoded transaction", "tags": [ "passport" ], - "operationId": "deleteUser", + "operationId": "getTransactionMetadata", "security": [ { - "OktaBearerAuth": [ - "retool_role_passportAccountDeletions" + "BearerAuth": [ + "transact" ] } ], + "parameters": [ + { + "name": "chain_name", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/ChainName" + } + } + ], "requestBody": { - "description": "The request body to delete a user's Passport account", "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteUserRequest" + "$ref": "#/components/schemas/GetTransactionMetadataRequest" } } } }, "responses": { - "201": { - "description": "User deleted response", + "200": { + "description": "Get transaction metadata response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteUserRes" + "$ref": "#/components/schemas/GetTransactionMetadataRes" } } } @@ -4512,16 +4448,6 @@ } } }, - "409": { - "description": "ConflictError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError409" - } - } - } - }, "429": { "description": "TooManyRequestsError", "content": { @@ -4555,39 +4481,49 @@ } } }, - "/passport-mr/v1/users/email": { - "patch": { + "/v1/chains/{chain_name}/passport/typeddata-metadata": { + "post": { "x-internal": true, - "summary": "Update user email (sandbox only)", - "description": "Updates the email_address for a user in the users table, identified by wallet address.\nOnly available in sandbox.\n", + "summary": "Get typeddata metadata", + "description": "Get typeddata metadata for a given encoded typeddata", "tags": [ "passport" ], - "operationId": "updateUserEmail", + "operationId": "getTypedDataMetadata", "security": [ { - "OktaBearerAuth": [ - "retool_role_editor" + "BearerAuth": [ + "transact" ] } ], + "parameters": [ + { + "name": "chain_name", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/ChainName" + } + } + ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateUserEmailRequest" + "$ref": "#/components/schemas/GetTypedDataMetadataRequest" } } } }, "responses": { "200": { - "description": "User email updated", + "description": "Get typeddata metadata response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateUserEmailRes" + "$ref": "#/components/schemas/GetTypedDataMetadataRes" } } } @@ -4613,7 +4549,7 @@ } }, "403": { - "description": "ForbiddenError (e.g. not sandbox)", + "description": "ForbiddenError", "content": { "application/json": { "schema": { @@ -4665,55 +4601,61 @@ } } }, - "/v2/chains/{chain_name}/passport/counterfactual-address": { - "post": { - "x-internal": true, - "summary": "Create a counterfactual address v2", - "description": "Create a counterfactual address for a user based on their Ethereum address", + "/v1/heartbeat": { + "get": { "tags": [ - "passport" + "health" ], - "operationId": "createCounterfactualAddressV2", - "security": [ - { - "BearerAuth": [ - "transact" - ] + "summary": "Health check endpoint", + "operationId": "heartbeat", + "responses": { + "200": { + "description": "OK" } + } + } + }, + "/v1/staking/programs/{program_name}/epochs/{epoch_id}": { + "get": { + "x-public": true, + "x-internal": true, + "summary": "Get epoch", + "description": "Get epoch by ID", + "operationId": "GetEpoch", + "tags": [ + "gamefi" ], "parameters": [ { - "name": "chain_name", "in": "path", + "name": "program_name", "required": true, "schema": { - "$ref": "#/components/schemas/ChainName" + "$ref": "#/components/schemas/ProgramName" + } + }, + { + "in": "path", + "name": "epoch_id", + "required": true, + "schema": { + "$ref": "#/components/schemas/EpochID" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateCounterfactualAddressRequest" - } - } - } - }, "responses": { - "201": { - "description": "Counterfactual address created response", + "200": { + "description": "Epoch details", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateCounterfactualAddressRes" + "$ref": "#/components/schemas/GetEpochResponseBody" } } } }, "400": { - "description": "BadRequestError", + "description": "Bad request", "content": { "application/json": { "schema": { @@ -4722,42 +4664,12 @@ } } }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "409": { - "description": "ConflictError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError409" - } - } - } - }, - "429": { - "description": "TooManyRequestsError", + "404": { + "description": "NotFoundError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError429" + "$ref": "#/components/schemas/APIError404" } } } @@ -4771,68 +4683,51 @@ } } } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } } } } }, - "/v1/chains/{chain_name}/passport/users/{user_id}/linked-addresses": { + "/v1/staking/programs/{program_name}/wallets/{wallet_address}": { "get": { - "deprecated": true, - "summary": "Get Ethereum linked addresses for a user", - "description": "This API has been deprecated, please use https://docs.immutable.com/zkevm/api/reference/#/operations/getUserInfo instead to get a list of linked addresses.", + "x-public": true, + "x-internal": true, + "summary": "Get wallet staking info", + "description": "Get wallet staking info", + "operationId": "GetWalletStakingInfo", "tags": [ - "passport" + "gamefi" ], "parameters": [ { - "name": "user_id", "in": "path", - "description": "The user's userId", + "name": "program_name", "required": true, "schema": { - "type": "string" + "$ref": "#/components/schemas/ProgramName" } }, { - "name": "chain_name", "in": "path", + "name": "wallet_address", "required": true, "schema": { - "$ref": "#/components/schemas/ChainName" + "$ref": "#/components/schemas/EthereumAddress" } } ], - "operationId": "getLinkedAddresses", - "security": [ - { - "BearerAuth": [ - "openid" - ] - } - ], "responses": { "200": { - "description": "User's list of linked addresses response", + "description": "Wallet staking info", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetLinkedAddressesRes" + "$ref": "#/components/schemas/GetWalletStakingInfoResponseBody" } } } }, "400": { - "description": "BadRequestError", + "description": "Bad request", "content": { "application/json": { "schema": { @@ -4841,32 +4736,12 @@ } } }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "429": { - "description": "TooManyRequestsError", + "404": { + "description": "NotFoundError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError429" + "$ref": "#/components/schemas/APIError404" } } } @@ -4880,103 +4755,103 @@ } } } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } } } } }, - "/v1/chains/{chain_name}/passport/transaction-metadata": { + "/passport-profile/v1/phone-otp/verify": { "post": { - "x-internal": true, - "summary": "Get transaction metadata", - "description": "Get transaction metadata for a given encoded transaction", - "tags": [ - "passport" - ], - "operationId": "getTransactionMetadata", "security": [ { "BearerAuth": [ - "transact" + "openid" ] } ], - "parameters": [ - { - "name": "chain_name", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/ChainName" - } - } + "tags": [ + "passport profile" ], + "summary": "Verify phone OTP code against user phone number", + "description": "Verify phone OTP code for user supplied phone number", + "operationId": "verify-phone-otp", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetTransactionMetadataRequest" + "$ref": "#/components/schemas/PhoneNumberOTPVerificationRequest" } } } }, "responses": { "200": { - "description": "Get transaction metadata response", + "description": "OK" + }, + "400": { + "description": "BadRequestError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetTransactionMetadataRes" + "$ref": "#/components/schemas/APIError400" } } } }, - "400": { - "description": "BadRequestError", + "429": { + "description": "TooManyRequestsError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError400" + "$ref": "#/components/schemas/APIError429" } } } }, - "401": { - "description": "UnauthorizedError", + "500": { + "description": "InternalServerError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError401" + "$ref": "#/components/schemas/APIError500" } } } - }, - "403": { - "description": "ForbiddenError", + } + } + } + }, + "/passport-profile/v1/profile": { + "get": { + "security": [ + { + "BearerAuth": [ + "openid" + ] + } + ], + "tags": [ + "passport profile" + ], + "summary": "Get profile for authenticated user", + "description": "Get profile for the authenticated user's Passport wallet", + "operationId": "get-profile-by-authenticated-wallet", + "responses": { + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError403" + "$ref": "#/components/schemas/ProfileResponse" } } } }, - "404": { - "description": "NotFoundError", + "401": { + "description": "UnauthorizedError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError404" + "$ref": "#/components/schemas/APIError401" } } } @@ -5000,63 +4875,41 @@ } } } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } } } } }, - "/v1/chains/{chain_name}/passport/typeddata-metadata": { + "/passport-profile/v1/username": { "post": { - "x-internal": true, - "summary": "Get typeddata metadata", - "description": "Get typeddata metadata for a given encoded typeddata", - "tags": [ - "passport" - ], - "operationId": "getTypedDataMetadata", "security": [ { "BearerAuth": [ - "transact" + "openid" ] } ], - "parameters": [ - { - "name": "chain_name", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/ChainName" - } - } + "tags": [ + "passport profile" ], + "summary": "Update username", + "description": "Update username for the authenticated user's Passport wallet", + "operationId": "update-username", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetTypedDataMetadataRequest" + "$ref": "#/components/schemas/UsernameUpdateRequest" } } } }, "responses": { "200": { - "description": "Get typeddata metadata response", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetTypedDataMetadataRes" + "$ref": "#/components/schemas/UsernameUpdateResponse" } } } @@ -5091,26 +4944,6 @@ } } }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "429": { - "description": "TooManyRequestsError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError429" - } - } - } - }, "500": { "description": "InternalServerError", "content": { @@ -5120,43 +4953,41 @@ } } } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } } } } }, - "/passport-mr/v1/session-activity-contracts": { - "get": { - "x-internal": true, - "summary": "Get session activity contracts", - "description": "Retrieve session activity contracts with optional filtering", - "tags": [ - "passport" - ], - "operationId": "getPreOnboardingCheckInSessionActivityContracts", + "/passport-profile/v1/phone-otp": { + "post": { "security": [ { - "OktaBearerAuth": [ - "retool_role_editor" + "BearerAuth": [ + "openid" ] } ], + "tags": [ + "passport profile" + ], + "summary": "Send phone OTP code for user supplied phone number", + "description": "Send phone OTP code for user supplied phone number", + "operationId": "send-phone-otp", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PhoneNumberOTPRequest" + } + } + } + }, "responses": { "200": { - "description": "Session activity contracts retrieved successfully", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetPreOnboardingCheckInSessionActivityContractsRes" + "$ref": "#/components/schemas/PhoneNumberOTPResponse" } } } @@ -5192,7 +5023,7 @@ } }, "429": { - "description": "TooManyRequestsError", + "description": "BadRequestError", "content": { "application/json": { "schema": { @@ -5210,52 +5041,41 @@ } } } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } } } - }, + } + }, + "/passport-profile/v2/linked-wallets": { "post": { - "x-internal": true, - "summary": "Create session activity contract", - "description": "Create a new session activity contract for tracking user interactions", - "tags": [ - "passport" - ], - "operationId": "createPreOnboardingCheckInSessionActivityContract", "security": [ { - "OktaBearerAuth": [ - "retool_role_editor" + "BearerAuth": [ + "openid" ] } ], + "tags": [ + "passport profile" + ], + "summary": "Link wallet v2", + "description": "Link an external EOA wallet to an Immutable Passport account by providing an EIP-712 signature.", + "operationId": "link-wallet-v2", "requestBody": { - "description": "The request body to create a session activity contract", - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePreOnboardingCheckInSessionActivityContractRequest" + "$ref": "#/components/schemas/LinkWalletV2Request" } } } }, "responses": { - "201": { - "description": "Session activity contract created response", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePreOnboardingCheckInSessionActivityContractRes" + "$ref": "#/components/schemas/Wallet" } } } @@ -5290,26 +5110,6 @@ } } }, - "409": { - "description": "ConflictError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError409" - } - } - } - }, - "429": { - "description": "TooManyRequestsError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError429" - } - } - } - }, "500": { "description": "InternalServerError", "content": { @@ -5319,99 +5119,62 @@ } } } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - } - }, - "/v1/heartbeat": { - "get": { - "tags": [ - "health" - ], - "summary": "Health check endpoint", - "operationId": "heartbeat", - "responses": { - "200": { - "description": "OK" } } } }, - "/v1/staking/programs/{program_name}/epochs/{epoch_id}": { + "/passport-profile/v1/user/info": { "get": { - "x-public": true, - "x-internal": true, - "summary": "Get epoch", - "description": "Get epoch by ID", - "operationId": "GetEpoch", + "summary": "Get all info for a Passport user", + "description": "Get all the info for an authenticated Passport user", "tags": [ - "gamefi" + "passport profile" ], - "parameters": [ - { - "in": "path", - "name": "program_name", - "required": true, - "schema": { - "$ref": "#/components/schemas/ProgramName" - } - }, + "operationId": "getUserInfo", + "security": [ { - "in": "path", - "name": "epoch_id", - "required": true, - "schema": { - "$ref": "#/components/schemas/EpochID" - } + "BearerAuth": [ + "openid" + ] } ], "responses": { "200": { - "description": "Epoch details", + "description": "Passport user's info", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetEpochResponseBody" + "$ref": "#/components/schemas/UserInfo" } } } }, - "400": { - "description": "Bad request", + "401": { + "description": "UnauthorizedError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError400" + "$ref": "#/components/schemas/APIError401" } } } }, - "404": { - "description": "NotFoundError", + "500": { + "description": "InternalServerError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError404" + "$ref": "#/components/schemas/APIError500" } } } }, - "500": { - "description": "InternalServerError", + "default": { + "description": "unexpected error", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError500" + "$ref": "#/components/schemas/BasicAPIError" } } } @@ -5419,47 +5182,51 @@ } } }, - "/v1/staking/programs/{program_name}/wallets/{wallet_address}": { - "get": { - "x-public": true, + "/guardian/v1/transactions/{id}/evaluate": { + "post": { "x-internal": true, - "summary": "Get wallet staking info", - "description": "Get wallet staking info", - "operationId": "GetWalletStakingInfo", + "security": [ + { + "BearerAuth": [ + "transact" + ] + } + ], "tags": [ - "gamefi" + "guardian" ], + "summary": "Evaluate a transaction", + "description": "Check if the transaction is valid by transaction ID for EVM", + "operationId": "evaluateTransaction", "parameters": [ { - "in": "path", - "name": "program_name", - "required": true, - "schema": { - "$ref": "#/components/schemas/ProgramName" - } - }, - { - "in": "path", - "name": "wallet_address", - "required": true, - "schema": { - "$ref": "#/components/schemas/EthereumAddress" - } + "$ref": "#/components/parameters/TransactionId" } ], + "requestBody": { + "required": true, + "description": "Specifies the kind of transaction", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionEvaluationRequest" + } + } + } + }, "responses": { "200": { - "description": "Wallet staking info", + "description": "Expected response to a valid request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetWalletStakingInfoResponseBody" + "$ref": "#/components/schemas/TransactionEvaluationResponse" } } } }, "400": { - "description": "Bad request", + "description": "BadRequestError", "content": { "application/json": { "schema": { @@ -5468,6 +5235,16 @@ } } }, + "403": { + "description": "ForbiddenError", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError403" + } + } + } + }, "404": { "description": "NotFoundError", "content": { @@ -5478,63 +5255,22 @@ } } }, - "500": { - "description": "InternalServerError", + "409": { + "description": "ConflictError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - } - } - } - }, - "/passport-profile/v1/phone-otp/verify": { - "post": { - "security": [ - { - "BearerAuth": [ - "openid" - ] - } - ], - "tags": [ - "passport profile" - ], - "summary": "Verify phone OTP code against user phone number", - "description": "Verify phone OTP code for user supplied phone number", - "operationId": "verify-phone-otp", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumberOTPVerificationRequest" - } - } - } - }, - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" + "$ref": "#/components/schemas/APIError409" } } } }, - "429": { - "description": "TooManyRequestsError", + "422": { + "description": "UnprocessableEntityError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError429" + "$ref": "#/components/schemas/APIError422" } } } @@ -5552,48 +5288,60 @@ } } }, - "/passport-profile/v1/profile": { - "get": { + "/guardian/v1/messages/evaluate": { + "post": { + "x-internal": true, "security": [ { "BearerAuth": [ - "openid" + "transact" ] } ], "tags": [ - "passport profile" + "guardian" ], - "summary": "Get profile for authenticated user", - "description": "Get profile for the authenticated user's Passport wallet", - "operationId": "get-profile-by-authenticated-wallet", + "summary": "Evaluate an evm message to sign", + "description": "Check if a given message is valid for EVM", + "operationId": "evaluateMessage", + "requestBody": { + "required": true, + "description": "Specifies the kind of transaction", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MessageEvaluationRequest" + } + } + } + }, "responses": { "200": { - "description": "OK", + "description": "Expected response to a valid request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProfileResponse" + "$ref": "#/components/schemas/MessageEvaluationResponse" } } } }, - "401": { - "description": "UnauthorizedError", + "400": { + "description": "BadRequestError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError401" + "$ref": "#/components/schemas/APIError400" } } } }, - "429": { - "description": "TooManyRequestsError", + "403": { + "description": "ForbiddenError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError429" + "$ref": "#/components/schemas/APIError403" } } } @@ -5611,37 +5359,40 @@ } } }, - "/passport-profile/v1/username": { + "/guardian/v1/erc191-messages/evaluate": { "post": { + "x-internal": true, "security": [ { "BearerAuth": [ - "openid" + "transact" ] } ], "tags": [ - "passport profile" + "guardian" ], - "summary": "Update username", - "description": "Update username for the authenticated user's Passport wallet", - "operationId": "update-username", + "summary": "Evaluate an erc191 message to sign", + "description": "Check if a given erc191 message is valid", + "operationId": "evaluateErc191Message", "requestBody": { + "required": true, + "description": "Specifies the kind of transaction", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UsernameUpdateRequest" + "$ref": "#/components/schemas/ERC191MessageEvaluationRequest" } } } }, "responses": { "200": { - "description": "OK", + "description": "Expected response to a valid request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UsernameUpdateResponse" + "$ref": "#/components/schemas/MessageEvaluationResponse" } } } @@ -5656,16 +5407,6 @@ } } }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, "403": { "description": "ForbiddenError", "content": { @@ -5689,40 +5430,49 @@ } } }, - "/passport-profile/v1/phone-otp": { + "/guardian/v1/transactions/{payloadHash}/approve": { "post": { + "x-internal": true, "security": [ { - "BearerAuth": [ - "openid" + "BearerAuthWithClient": [ + "approve:transactions", + "transact" ] } ], "tags": [ - "passport profile" + "guardian" + ], + "summary": "Approve a pending transaction given chain", + "description": "Approve a pending transaction", + "operationId": "approvePendingTransaction", + "parameters": [ + { + "name": "payloadHash", + "in": "path", + "description": "Hash for the payload", + "required": true, + "schema": { + "type": "string", + "description": "Hash for the payload" + } + } ], - "summary": "Send phone OTP code for user supplied phone number", - "description": "Send phone OTP code for user supplied phone number", - "operationId": "send-phone-otp", "requestBody": { + "required": true, + "description": "request body for approving a pending transaction", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PhoneNumberOTPRequest" + "$ref": "#/components/schemas/TransactionApprovalRequest" } } } }, "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PhoneNumberOTPResponse" - } - } - } + "204": { + "description": "successfully approved a pending transaction" }, "400": { "description": "BadRequestError", @@ -5734,16 +5484,6 @@ } } }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, "403": { "description": "ForbiddenError", "content": { @@ -5754,12 +5494,12 @@ } } }, - "429": { - "description": "BadRequestError", + "404": { + "description": "NotFoundError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError429" + "$ref": "#/components/schemas/APIError404" } } } @@ -5777,40 +5517,38 @@ } } }, - "/passport-profile/v2/linked-wallets": { + "/guardian/v1/messages/{messageID}/approve": { "post": { + "x-internal": true, "security": [ { - "BearerAuth": [ - "openid" + "BearerAuthWithClient": [ + "approve:transactions", + "transact" ] } ], "tags": [ - "passport profile" + "guardian" ], - "summary": "Link wallet v2", - "description": "Link an external EOA wallet to an Immutable Passport account by providing an EIP-712 signature.", - "operationId": "link-wallet-v2", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LinkWalletV2Request" - } + "summary": "Approve a pending evm message", + "description": "Approve a pending evm message", + "operationId": "approvePendingMessage", + "parameters": [ + { + "name": "messageID", + "in": "path", + "description": "id for the message", + "required": true, + "schema": { + "type": "string", + "description": "Hash for the payload" } } - }, + ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Wallet" - } - } - } + "204": { + "description": "successfully approved a pending evm message" }, "400": { "description": "BadRequestError", @@ -5822,22 +5560,22 @@ } } }, - "401": { - "description": "UnauthorizedError", + "403": { + "description": "ForbiddenError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError401" + "$ref": "#/components/schemas/APIError403" } } } }, - "403": { - "description": "ForbiddenError", + "404": { + "description": "NotFoundError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError403" + "$ref": "#/components/schemas/APIError404" } } } @@ -5855,58 +5593,75 @@ } } }, - "/passport-profile/v1/user/info": { - "get": { - "summary": "Get all info for a Passport user", - "description": "Get all the info for an authenticated Passport user", - "tags": [ - "passport profile" - ], - "operationId": "getUserInfo", + "/guardian/v1/erc191-messages/{messageID}/approve": { + "post": { + "x-internal": true, "security": [ { - "BearerAuth": [ - "openid" + "BearerAuthWithClient": [ + "approve:transactions", + "transact" ] } ], - "responses": { - "200": { - "description": "Passport user's info", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" + "tags": [ + "guardian" + ], + "summary": "Approve a pending erc191 message", + "description": "Approve a pending erc191 message", + "operationId": "approvePendingERC191Message", + "parameters": [ + { + "name": "messageID", + "in": "path", + "description": "id for the message", + "required": true, + "schema": { + "type": "string", + "description": "Hash for the payload" + } + } + ], + "responses": { + "204": { + "description": "successfully approved a pending erc191 message" + }, + "400": { + "description": "BadRequestError", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError400" } } } }, - "401": { - "description": "UnauthorizedError", + "403": { + "description": "ForbiddenError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError401" + "$ref": "#/components/schemas/APIError403" } } } }, - "500": { - "description": "InternalServerError", + "404": { + "description": "NotFoundError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError500" + "$ref": "#/components/schemas/APIError404" } } } }, - "default": { - "description": "unexpected error", + "500": { + "description": "InternalServerError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BasicAPIError" + "$ref": "#/components/schemas/APIError500" } } } @@ -5914,58 +5669,60 @@ } } }, - "/passport-profile/v1/feed-items": { + "/guardian/v1/transactions/{transactionID}": { "get": { "x-internal": true, - "tags": [ - "feed-items" - ], - "summary": "Get feed items", - "description": "Get feed items", + "summary": "Info for a specific transaction", + "description": "Get a transaction by payload hash", + "operationId": "getTransactionByID", "security": [ { - "OktaBearerAuth": [ - "retool_role_editor" + "BearerAuth": [ + "transact" ] } ], - "operationId": "get-feed-items", + "tags": [ + "guardian" + ], "parameters": [ { - "$ref": "#/components/parameters/Offset" - }, - { - "$ref": "#/components/parameters/PageSizeParam" - }, - { - "$ref": "#/components/parameters/SortField" - }, - { - "$ref": "#/components/parameters/SortDirection" + "name": "transactionID", + "in": "path", + "required": true, + "description": "The id of the transaction to retrieve", + "schema": { + "type": "string" + } }, { - "name": "status", "in": "query", - "description": "Filter by status", - "required": false, + "name": "chainType", "schema": { "type": "string", "enum": [ - "published", - "draft", - "scheduled", - "archived" + "evm" ] - } + }, + "required": true, + "description": "roll up type" + }, + { + "in": "query", + "name": "chainID", + "schema": { + "type": "string" + }, + "description": "ID of evm chain" } ], "responses": { "200": { - "description": "Successfully get feed items", + "description": "Expected response to a valid request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FeedItemsResponse" + "$ref": "#/components/schemas/Transaction" } } } @@ -5980,22 +5737,22 @@ } } }, - "401": { - "description": "UnauthorizedError", + "403": { + "description": "ForbiddenError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError401" + "$ref": "#/components/schemas/APIError403" } } } }, - "403": { - "description": "ForbiddenError", + "404": { + "description": "NotFoundError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError403" + "$ref": "#/components/schemas/APIError404" } } } @@ -6009,59 +5766,54 @@ } } } + }, + "default": { + "description": "unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BasicAPIError" + } + } + } } } - }, - "post": { + } + }, + "/guardian/v1/messages/{messageID}": { + "get": { "x-internal": true, - "tags": [ - "feed-items" - ], - "summary": "Create a feed item", - "description": "Create a feed item", + "summary": "Info for a specific evm message", + "description": "Get an evm message by id", + "operationId": "getMessageByID", "security": [ { - "OktaBearerAuth": [ - "retool_role_editor" + "BearerAuth": [ + "transact" ] } ], - "operationId": "create-feed-item", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateUpdateFeedItemRequest" - } + "tags": [ + "guardian" + ], + "parameters": [ + { + "name": "messageID", + "in": "path", + "required": true, + "description": "The id of the evm message", + "schema": { + "type": "string" } } - }, + ], "responses": { - "201": { - "description": "Successfully created feed item", - "headers": { - "Location": { - "description": "Location of the created feed item", - "required": true, - "schema": { - "type": "string", - "format": "uri" - } - } - }, + "200": { + "description": "Expected response to a valid request", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/FeedItemResponse" - } - }, - "required": [ - "result" - ] + "$ref": "#/components/schemas/EVMMessage" } } } @@ -6076,22 +5828,22 @@ } } }, - "401": { - "description": "UnauthorizedError", + "403": { + "description": "ForbiddenError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError401" + "$ref": "#/components/schemas/APIError403" } } } }, - "403": { - "description": "ForbiddenError", + "404": { + "description": "NotFoundError", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIError403" + "$ref": "#/components/schemas/APIError404" } } } @@ -6105,43 +5857,54 @@ } } } + }, + "default": { + "description": "unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BasicAPIError" + } + } + } } } } }, - "/passport-profile/v1/feed-items/actions/update-status": { - "post": { + "/guardian/v1/erc191-messages/{messageID}": { + "get": { "x-internal": true, - "tags": [ - "feed-items" - ], - "summary": "Update feed items status", - "description": "Apply a new value in feed items status", + "summary": "Info for a specific erc191 message", + "description": "Get an erc191 message by id", + "operationId": "getErc191MessageByID", "security": [ { - "OktaBearerAuth": [ - "retool_role_editor" + "BearerAuth": [ + "transact" ] } ], - "operationId": "update-feed-items-status", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedItemsStatusRequest" - } + "tags": [ + "guardian" + ], + "parameters": [ + { + "name": "messageID", + "in": "path", + "required": true, + "description": "The id of the erc191 message", + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "Successfully update feed items status", + "description": "Expected response to a valid request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FeedItemsStatusResponse" + "$ref": "#/components/schemas/Erc191MessageResponse" } } } @@ -6156,16 +5919,6 @@ } } }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, "403": { "description": "ForbiddenError", "content": { @@ -6195,5270 +5948,1407 @@ } } } + }, + "default": { + "description": "unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BasicAPIError" + } + } + } } } } }, - "/passport-profile/v1/feed-items/{feed_item_id}": { + "/v1/chains/{chain_name}/search/filters/{contract_address}": { "get": { - "x-internal": true, "tags": [ - "feed-items" - ], - "summary": "Get a feed item", - "description": "Get a feed item", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } + "metadata-search" ], - "operationId": "get-feed-item", + "operationId": "ListFilters", + "summary": "Get list of metadata attribute filters", + "description": "Get list of metadata filters", "parameters": [ { - "$ref": "#/components/parameters/FeedItemIdParam" - } - ], - "responses": { - "200": { - "description": "Successfully get feed item", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FeedItemResult" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } + "name": "chain_name", + "description": "The name of chain", + "schema": { + "$ref": "#/components/schemas/ChainName" + }, + "in": "path", + "required": true, + "examples": { + "testnet": { + "value": "imtbl-zkevm-testnet", + "summary": "Immutable zkEVM Public Testnet" } } }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - } - } - }, - "put": { - "x-internal": true, - "tags": [ - "feed-items" - ], - "summary": "Update a feed item", - "description": "Update a feed item", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } - ], - "operationId": "update-feed-item", - "parameters": [ { - "$ref": "#/components/parameters/FeedItemIdParam" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateUpdateFeedItemRequest" - } + "name": "contract_address", + "in": "path", + "required": true, + "description": "Contract addresses for collection", + "schema": { + "type": "string", + "pattern": "^0x[a-fA-F0-9]{40}$", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" } } - }, + ], "responses": { "200": { - "description": "Successfully updated feed item", + "description": "200 response", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/FeedItemResponse" - } - }, - "required": [ - "result" - ] + "$ref": "#/components/schemas/ListFiltersResult" } } } }, "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } + "$ref": "#/components/responses/BadRequest" }, "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } + "$ref": "#/components/responses/UnauthorisedRequest" }, "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } + "$ref": "#/components/responses/ForbiddenRequest" }, "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } + "$ref": "#/components/responses/NotFound" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" }, "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } + "$ref": "#/components/responses/InternalServerError" } } } }, - "/passport-profile/v1/feed-items/assets": { + "/v1/chains/{chain_name}/search/nfts": { "get": { - "x-internal": true, "tags": [ - "feed-items", - "assets" - ], - "summary": "Get list of feed items assets", - "description": "Get list of feed items assets", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } + "metadata-search" ], - "operationId": "get-feed-items-assets", + "operationId": "SearchNFTs", + "summary": "Search NFTs", + "description": "Search NFTs", "parameters": [ { - "$ref": "#/components/parameters/PageCursorParam" + "name": "chain_name", + "description": "The name of chain", + "schema": { + "$ref": "#/components/schemas/ChainName" + }, + "in": "path", + "required": true, + "examples": { + "testnet": { + "value": "imtbl-zkevm-testnet", + "summary": "Immutable zkEVM Public Testnet" + } + } + }, + { + "name": "contract_address", + "in": "query", + "required": true, + "description": "List of contract addresses to filter by", + "schema": { + "type": "array", + "items": { + "type": "string", + "pattern": "^0x[a-fA-F0-9]{40}$", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" + }, + "maxItems": 20, + "minItems": 1 + } + }, + { + "name": "account_address", + "in": "query", + "required": false, + "description": "Account address to filter by", + "schema": { + "type": "string", + "pattern": "^0x[a-fA-F0-9]{40}$", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" + } + }, + { + "name": "stack_id", + "in": "query", + "required": false, + "description": "Filters NFTs that belong to any of these stacks", + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "example": "7053e765-c119-4efb-b5cf-405ccccaf6c4" + }, + "minItems": 1, + "maxItems": 20 + } + }, + { + "name": "only_include_owner_listings", + "in": "query", + "required": false, + "description": "Whether the listings should include only the owner created listings", + "schema": { + "type": "boolean", + "example": true + } }, { - "$ref": "#/components/parameters/PageSizeParam" + "name": "page_size", + "in": "query", + "required": false, + "description": "Number of results to return per page", + "schema": { + "$ref": "#/components/schemas/PageSize" + } }, { - "$ref": "#/components/parameters/FeedItemAssetTypeParam" + "name": "page_cursor", + "in": "query", + "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", + "required": false, + "schema": { + "$ref": "#/components/schemas/PageCursor" + } } ], "responses": { "200": { - "description": "Successfully get list of feed items assets", + "description": "200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FeedItemsAssetsResponse" + "$ref": "#/components/schemas/SearchNFTsResult" } } } }, "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } + "$ref": "#/components/responses/BadRequest" }, "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } + "$ref": "#/components/responses/UnauthorisedRequest" }, "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } + "$ref": "#/components/responses/ForbiddenRequest" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" }, "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } + "$ref": "#/components/responses/InternalServerError" } } } }, - "/passport-profile/v1/feed-items/assets/bulk": { - "post": { - "x-internal": true, + "/v1/chains/{chain_name}/search/stacks": { + "get": { "tags": [ - "feed-items", - "assets" + "metadata-search" ], - "summary": "Create a bunch of feed items assets", - "description": "Create a bunch of feed items assets", - "security": [ + "operationId": "SearchStacks", + "summary": "Search NFT stacks", + "description": "Search NFT stacks", + "parameters": [ { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } - ], - "operationId": "create-feed-items-assets", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateFeedItemsAssetsRequest" - } - } - } + "name": "chain_name", + "description": "The name of chain", + "schema": { + "$ref": "#/components/schemas/ChainName" + }, + "in": "path", + "required": true, + "examples": { + "testnet": { + "value": "imtbl-zkevm-testnet", + "summary": "Immutable zkEVM Public Testnet" } } - } - }, - "responses": { - "200": { - "description": "Successfully created feed items assets", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } + }, + { + "name": "contract_address", + "in": "query", + "required": true, + "description": "List of contract addresses to filter by", + "schema": { + "type": "array", + "items": { + "type": "string", + "pattern": "^0x[a-fA-F0-9]{40}$", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" + }, + "maxItems": 20, + "minItems": 1 } }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } + { + "name": "account_address", + "in": "query", + "required": false, + "description": "Account address to filter by", + "schema": { + "type": "string", + "pattern": "^0x[a-fA-F0-9]{40}$", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" } }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } + { + "name": "only_include_owner_listings", + "in": "query", + "required": false, + "description": "Whether to the listings should include only the owner created listings", + "schema": { + "type": "boolean", + "example": true } }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } + { + "name": "only_if_has_active_listings", + "in": "query", + "required": false, + "description": "Filters results to include only stacks that have a current active listing. False and 'null' return all unfiltered stacks.", + "schema": { + "type": "boolean", + "example": true } }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } + { + "name": "traits", + "in": "query", + "required": false, + "description": "JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\"rarity\": {\"values\": [\"common\", \"rare\"], \"condition\": \"eq\"}}))", + "schema": { + "type": "string" } - } - } - } - }, - "/passport-profile/v1/{game_id}/assets": { - "get": { - "x-internal": true, - "tags": [ - "passport profile" - ], - "summary": "Get list of assets for a game", - "description": "Get list of assets for a game", - "security": [ + }, { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } - ], - "operationId": "get-game-assets", - "parameters": [ + "name": "keyword", + "in": "query", + "required": false, + "description": "Keyword to search NFT name and description. Alphanumeric characters only.", + "schema": { + "type": "string", + "example": "sword" + } + }, { - "name": "game_id", - "in": "path", - "description": "The UUID of the game the file belongs to", - "required": true, + "name": "payment_token", + "in": "query", + "required": false, + "description": "Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or 'NATIVE'", "schema": { "type": "string", - "format": "uuid" + "example": "NATIVE" + } + }, + { + "name": "sort_by", + "in": "query", + "required": false, + "description": "Sort results in a specific order", + "schema": { + "type": "string", + "nullable": false, + "enum": [ + "cheapest_first" + ] } }, { - "$ref": "#/components/parameters/PageCursorParam" + "name": "page_size", + "in": "query", + "required": false, + "description": "Number of results to return per page", + "schema": { + "$ref": "#/components/schemas/PageSize" + } }, { - "$ref": "#/components/parameters/PageSizeParam" + "name": "page_cursor", + "in": "query", + "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", + "required": false, + "schema": { + "$ref": "#/components/schemas/PageCursor" + } } ], "responses": { "200": { - "description": "Successfully get list of assets for a game", + "description": "200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FeedItemsAssetsResponse" + "$ref": "#/components/schemas/SearchStacksResult" } } } }, "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } + "$ref": "#/components/responses/BadRequest" }, "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } + "$ref": "#/components/responses/UnauthorisedRequest" }, "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } + "$ref": "#/components/responses/ForbiddenRequest" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" }, "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } + "$ref": "#/components/responses/InternalServerError" } } } }, - "/passport-profile/v1/{game_id}/assets/presign-upload": { + "/v1/chains/{chain_name}/stacks": { "get": { - "x-internal": true, "tags": [ - "passport profile" - ], - "summary": "Get url to where the asset should be uploaded", - "description": "Get url to where the asset should be uploaded", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } + "metadata" ], - "operationId": "get-game-presign-upload", + "operationId": "ListStacks", + "summary": "List NFT stack bundles by stack_id. Response will include Market, Listings & Stack Count information for each stack", + "description": "List NFT stack bundles by stack_id. This endpoint functions similarly to `ListMetadataByID` but extends the response to include Market, Listings & Stack Count information for each stack.", "parameters": [ { - "name": "file_name", - "in": "query", - "description": "The name of the file to be uploaded to the returned url", - "required": true, + "name": "chain_name", + "description": "The name of chain", "schema": { - "type": "string" + "$ref": "#/components/schemas/ChainName" + }, + "in": "path", + "required": true, + "examples": { + "testnet": { + "value": "imtbl-zkevm-testnet", + "summary": "Immutable zkEVM Public Testnet" + } } }, { - "name": "game_id", - "in": "path", - "description": "The UUID of the game the file belongs to", + "name": "stack_id", + "in": "query", "required": true, + "description": "List of stack_id to filter by", "schema": { - "type": "string", - "format": "uuid" + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "example": "7053e765-c119-4efb-b5cf-405ccccaf6c4" + }, + "maxItems": 20, + "minItems": 1 } } ], "responses": { "200": { - "description": "Successfully get url to where the asset should be uploaded", + "description": "200 response", "content": { "application/json": { "schema": { - "description": "Presigned upload response", - "type": "object", - "properties": { - "url": { - "type": "string" - } - }, - "required": [ - "url" - ] + "type": "array", + "description": "List of stack bundles", + "items": { + "$ref": "#/components/schemas/StackBundle" + } } } } }, "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } + "$ref": "#/components/responses/BadRequest" }, "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } + "$ref": "#/components/responses/UnauthorisedRequest" }, "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } + "$ref": "#/components/responses/ForbiddenRequest" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" }, "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } + "$ref": "#/components/responses/InternalServerError" } } } }, - "/passport-profile/v1/m2m/{game_id}/assets/presign-upload": { + "/v1/chains/{chain_name}/quotes/{contract_address}/stacks": { "get": { - "x-internal": true, "tags": [ - "passport profile" + "pricing" ], - "summary": "Get url to where the asset should be uploaded (M2M)", - "description": "Get url to where the asset should be uploaded via M2M authentication", - "security": [], - "operationId": "m2m-get-game-presign-upload", + "operationId": "QuotesForStacks", + "summary": "Get pricing data for a list of stack ids", + "description": "Get pricing data for a list of stack ids", "parameters": [ { - "name": "file_name", - "in": "query", - "description": "The name of the file to be uploaded to the returned url", + "name": "chain_name", + "description": "The name of chain", + "schema": { + "$ref": "#/components/schemas/ChainName" + }, + "in": "path", + "required": true, + "examples": { + "testnet": { + "value": "imtbl-zkevm-testnet", + "summary": "Immutable zkEVM Public Testnet" + } + } + }, + { + "name": "contract_address", + "in": "path", "required": true, + "description": "Contract address for collection that these stacks are on", "schema": { + "pattern": "^0x[a-fA-F0-9]{40}$", "type": "string" } }, { - "name": "game_id", - "in": "path", - "description": "The UUID of the game the file belongs to", + "name": "stack_id", + "in": "query", "required": true, + "description": "List of stack ids to get pricing data for", + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "example": "7053e765-c119-4efb-b5cf-405ccccaf6c4" + }, + "minItems": 1, + "maxItems": 20 + } + }, + { + "name": "payment_token", + "in": "query", + "required": false, + "description": "Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or 'NATIVE'.", "schema": { "type": "string", - "format": "uuid" + "example": "NATIVE" + } + }, + { + "name": "page_cursor", + "in": "query", + "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", + "required": false, + "schema": { + "$ref": "#/components/schemas/PageCursor" } } ], "responses": { "200": { - "description": "Successfully get url to where the asset should be uploaded", + "description": "200 response", "content": { "application/json": { "schema": { - "description": "Presigned upload response", - "type": "object", - "properties": { - "url": { - "type": "string" - } - }, - "required": [ - "url" - ] + "$ref": "#/components/schemas/QuotesForStacksResult" } } } }, "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } + "$ref": "#/components/responses/BadRequest" }, "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } + "$ref": "#/components/responses/UnauthorisedRequest" }, "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } + "$ref": "#/components/responses/ForbiddenRequest" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" }, "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } + "$ref": "#/components/responses/InternalServerError" } } } }, - "/passport-profile/v1/feed-items/assets/presign-upload": { + "/v1/chains/{chain_name}/quotes/{contract_address}/nfts": { "get": { - "x-internal": true, "tags": [ - "feed-items", - "assets" - ], - "summary": "Get url to where the asset should be uploaded", - "description": "Get url to where the asset should be uploaded", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } + "pricing" ], - "operationId": "get-feed-items-presign-upload", + "operationId": "QuotesForNFTs", + "summary": "Get pricing data for a list of token ids", + "description": "pricing data for a list of token ids", "parameters": [ { - "name": "file_name", - "in": "query", - "description": "The name of the file to be uploaded to the returned url", - "required": true, + "name": "chain_name", + "description": "The name of chain", "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully get url to where the asset should be uploaded", - "content": { - "application/json": { - "schema": { - "description": "Presigned upload response", - "type": "object", - "properties": { - "url": { - "type": "string" - } - }, - "required": [ - "url" - ] - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } + "$ref": "#/components/schemas/ChainName" + }, + "in": "path", + "required": true, + "examples": { + "testnet": { + "value": "imtbl-zkevm-testnet", + "summary": "Immutable zkEVM Public Testnet" } } }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - } - } - } - }, - "/passport-profile/v1/internal/assets/{game_id}/{path}": { - "get": { - "x-internal": true, - "tags": [ - "passport profile" - ], - "summary": "Get list of assets for a game at a specific path", - "description": "Lists assets under {game_id}/{path}/ prefix in S3.\nReturns asset metadata including CDN URL, with cursor-based pagination.\nUse page_cursor from the previous response to fetch the next page.\nNo more results when next_cursor is null.\n", - "security": [ - { - "BearerAuth": [ - "openid" - ] - } - ], - "operationId": "get-internal-assets", - "parameters": [ { - "name": "game_id", + "name": "contract_address", "in": "path", - "description": "The UUID of the game", "required": true, + "description": "Contract address for collection that these token ids are on", "schema": { "type": "string", - "format": "uuid" + "pattern": "^0x[a-fA-F0-9]{40}$" } }, { - "name": "path", - "in": "path", - "description": "The asset path within the game", + "name": "token_id", + "in": "query", "required": true, + "description": "List of token ids to get pricing data for", "schema": { - "type": "string", - "enum": [ - "email", - "game-page" - ] + "type": "array", + "items": { + "type": "string", + "pattern": "^\\d+$", + "example": "1337" + }, + "minItems": 1, + "maxItems": 20 } }, { - "$ref": "#/components/parameters/PageCursorParam" - }, - { - "$ref": "#/components/parameters/PageSizeParam" + "name": "payment_token", + "in": "query", + "required": false, + "description": "Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or 'NATIVE'.", + "schema": { + "type": "string", + "example": "NATIVE" + } }, { - "name": "search_term", + "name": "page_cursor", "in": "query", - "description": "Optional prefix search term. Matching is case-sensitive.\n", + "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", "required": false, "schema": { - "type": "string" + "$ref": "#/components/schemas/PageCursor" } } ], "responses": { "200": { - "description": "Successfully retrieved list of internal assets", + "description": "200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InternalAssetsResponse" + "$ref": "#/components/schemas/QuotesForNFTsResult" } } } }, "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } + "$ref": "#/components/responses/BadRequest" }, "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } + "$ref": "#/components/responses/UnauthorisedRequest" }, "403": { - "description": "ForbiddenError - User does not own this game", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } + "$ref": "#/components/responses/ForbiddenRequest" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" }, "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } + "$ref": "#/components/responses/InternalServerError" } } } + } + }, + "components": { + "securitySchemes": { + "BearerAuthWithClient": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + }, + "BearerAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + }, + "ImmutableApiKey": { + "x-go-name": "ImmutableApiKey", + "type": "apiKey", + "in": "header", + "name": "x-immutable-api-key" + } }, - "/passport-profile/v1/internal/assets/{game_id}/{path}/presign-upload": { - "get": { - "x-internal": true, - "tags": [ - "passport profile" - ], - "summary": "Get presigned URL to upload an asset for a game", - "description": "Generates a presigned PUT URL for uploading an asset to S3.\nValidates file extension (.png, .jpg, .jpeg, .webp, .gif) and content type.\nValidates content_length is <= 5MB (5,242,880 bytes).\nChecks current asset count; rejects if at limit (20 assets max per game/path).\nURL expires in 5 minutes.\nS3 enforces Content-Type and Content-Length conditions on upload.\n", - "security": [ - { - "BearerAuth": [ - "openid" - ] + "parameters": { + "ChainName": { + "name": "chain_name", + "description": "The name of chain", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/ChainName" + }, + "examples": { + "testnet": { + "value": "imtbl-zkevm-testnet", + "summary": "Immutable zkEVM Public Testnet" } - ], - "operationId": "get-internal-presign-upload", - "parameters": [ - { - "name": "game_id", - "in": "path", - "description": "The UUID of the game", - "required": true, + } + }, + "ContractAddress": { + "name": "contract_address", + "in": "path", + "required": true, + "description": "Contract address", + "schema": { + "$ref": "#/components/schemas/Address" + } + }, + "TransactionId": { + "name": "id", + "in": "path", + "description": "Transaction identifier: EVM transaction ID", + "required": true, + "schema": { + "type": "string", + "description": "Hash of the transaction" + } + } + }, + "responses": { + "NotFound": { + "description": "The specified resource was not found (404)", + "content": { + "application/json": { "schema": { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/APIError404" } - }, - { - "name": "path", - "in": "path", - "description": "The asset path within the game", - "required": true, + } + } + }, + "BadRequest": { + "description": "Bad Request (400)", + "content": { + "application/json": { "schema": { - "type": "string", - "enum": [ - "email", - "game-page" - ] + "$ref": "#/components/schemas/APIError400" } - }, - { - "name": "file_name", - "in": "query", - "description": "Name of the file to be uploaded (must have valid extension)", - "required": true, + } + } + }, + "UnauthorisedRequest": { + "description": "Unauthorised Request (401)", + "content": { + "application/json": { "schema": { - "type": "string", - "minLength": 1, - "maxLength": 255 + "$ref": "#/components/schemas/APIError401" } - }, - { - "name": "content_type", - "in": "query", - "description": "Content type of the file (image/png, image/jpeg, image/webp, image/gif)", - "required": true, + } + } + }, + "ForbiddenRequest": { + "description": "Forbidden Request (403)", + "content": { + "application/json": { "schema": { - "type": "string", - "enum": [ - "image/png", - "image/jpeg", - "image/webp", - "image/gif" - ] + "$ref": "#/components/schemas/APIError403" } - }, - { - "name": "content_length", - "in": "query", - "description": "Size of the file in bytes (max 5MB = 5242880 bytes)", - "required": true, + } + } + }, + "Conflict": { + "description": "Conflict (409)", + "content": { + "application/json": { "schema": { - "type": "integer", - "minimum": 1, - "maximum": 5242880 + "$ref": "#/components/schemas/APIError409" } } - ], - "responses": { - "200": { - "description": "Successfully generated presigned upload URL", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InternalPresignUploadResponse" - } - } - } - }, - "400": { - "description": "BadRequestError - Invalid file extension, content type, or size", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } + } + }, + "TooManyRequests": { + "description": "Too Many Requests (429)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError429" } - }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } + } + }, + "headers": { + "Retry-After": { + "$ref": "#/components/headers/RetryAfter" + } + } + }, + "TooManyMetadataRefreshes": { + "description": "Too Many Metadata refreshes (429)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError429" } + } + }, + "headers": { + "imx-refreshes-limit": { + "$ref": "#/components/headers/MetadataRefreshLimit" }, - "403": { - "description": "ForbiddenError - User does not own this game", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } + "imx-refresh-limit-reset": { + "$ref": "#/components/headers/MetadataRefreshLimitReset" }, - "409": { - "description": "ConflictError - Asset limit reached (max 20 assets per game/path)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError409" - } - } - } + "imx-remaining-refreshes": { + "$ref": "#/components/headers/MetadataRefreshLimitRemaining" }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } + "Retry-After": { + "$ref": "#/components/headers/MetadataRefreshRetryAfter" } } - } - }, - "/guardian/v1/transactions/{id}/evaluate": { - "post": { - "x-internal": true, - "security": [ - { - "BearerAuth": [ - "transact" - ] - } - ], - "tags": [ - "guardian" - ], - "summary": "Evaluate a transaction", - "description": "Check if the transaction is valid by transaction ID for EVM", - "operationId": "evaluateTransaction", - "parameters": [ - { - "$ref": "#/components/parameters/TransactionId" - } - ], - "requestBody": { - "required": true, - "description": "Specifies the kind of transaction", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionEvaluationRequest" - } + }, + "TooManyMintRequests": { + "description": "Too Many mint requests (429)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError429" } } }, - "responses": { - "200": { - "description": "Expected response to a valid request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionEvaluationResponse" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } + "headers": { + "imx-mint-requests-limit": { + "$ref": "#/components/headers/MintRequestsLimit" }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } + "imx-mint-requests-limit-reset": { + "$ref": "#/components/headers/MintRequestsLimitReset" }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } + "imx-remaining-mint-requests": { + "$ref": "#/components/headers/MintRequestsLimitRemaining" }, - "409": { - "description": "ConflictError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError409" - } - } - } + "imx-mint-requests-retry-after": { + "$ref": "#/components/headers/MintRequestsRetryAfter" }, - "422": { - "description": "UnprocessableEntityError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError422" - } - } + "Retry-After": { + "$ref": "#/components/headers/MintRequestsRetryAfter" + } + } + }, + "InternalServerError": { + "description": "Internal Server Error (500)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError500" } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } + } + } + }, + "NotImplementedError": { + "description": "Not Implemented Error (501)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError501" } } } - } - }, - "/guardian/v1/messages/evaluate": { - "post": { - "x-internal": true, - "security": [ - { - "BearerAuth": [ - "transact" - ] + }, + "ServiceUnavailable": { + "description": "Service Unavailable (503) - RPC or upstream service temporarily unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError503" + } } - ], - "tags": [ - "guardian" - ], - "summary": "Evaluate an evm message to sign", - "description": "Check if a given message is valid for EVM", - "operationId": "evaluateMessage", - "requestBody": { - "required": true, - "description": "Specifies the kind of transaction", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageEvaluationRequest" - } + } + }, + "GatewayTimeout": { + "description": "Gateway Timeout (504) - Upstream validation request timed out", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIError504" } } - }, - "responses": { - "200": { - "description": "Expected response to a valid request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageEvaluationResponse" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - } - } - } - }, - "/guardian/v1/erc191-messages/evaluate": { - "post": { - "x-internal": true, - "security": [ - { - "BearerAuth": [ - "transact" - ] - } - ], - "tags": [ - "guardian" - ], - "summary": "Evaluate an erc191 message to sign", - "description": "Check if a given erc191 message is valid", - "operationId": "evaluateErc191Message", - "requestBody": { - "required": true, - "description": "Specifies the kind of transaction", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ERC191MessageEvaluationRequest" - } - } - } - }, - "responses": { - "200": { - "description": "Expected response to a valid request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageEvaluationResponse" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - } - } - } - }, - "/guardian/v1/transactions/{payloadHash}/approve": { - "post": { - "x-internal": true, - "security": [ - { - "BearerAuthWithClient": [ - "approve:transactions", - "transact" - ] - } - ], - "tags": [ - "guardian" - ], - "summary": "Approve a pending transaction given chain", - "description": "Approve a pending transaction", - "operationId": "approvePendingTransaction", - "parameters": [ - { - "name": "payloadHash", - "in": "path", - "description": "Hash for the payload", - "required": true, - "schema": { - "type": "string", - "description": "Hash for the payload" - } - } - ], - "requestBody": { - "required": true, - "description": "request body for approving a pending transaction", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TransactionApprovalRequest" - } - } - } - }, - "responses": { - "204": { - "description": "successfully approved a pending transaction" - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - } - } - } - }, - "/guardian/v1/messages/{messageID}/approve": { - "post": { - "x-internal": true, - "security": [ - { - "BearerAuthWithClient": [ - "approve:transactions", - "transact" - ] - } - ], - "tags": [ - "guardian" - ], - "summary": "Approve a pending evm message", - "description": "Approve a pending evm message", - "operationId": "approvePendingMessage", - "parameters": [ - { - "name": "messageID", - "in": "path", - "description": "id for the message", - "required": true, - "schema": { - "type": "string", - "description": "Hash for the payload" - } - } - ], - "responses": { - "204": { - "description": "successfully approved a pending evm message" - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - } - } - } - }, - "/guardian/v1/erc191-messages/{messageID}/approve": { - "post": { - "x-internal": true, - "security": [ - { - "BearerAuthWithClient": [ - "approve:transactions", - "transact" - ] - } - ], - "tags": [ - "guardian" - ], - "summary": "Approve a pending erc191 message", - "description": "Approve a pending erc191 message", - "operationId": "approvePendingERC191Message", - "parameters": [ - { - "name": "messageID", - "in": "path", - "description": "id for the message", - "required": true, - "schema": { - "type": "string", - "description": "Hash for the payload" - } - } - ], - "responses": { - "204": { - "description": "successfully approved a pending erc191 message" - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - } - } - } - }, - "/guardian/v1/transactions/{transactionID}": { - "get": { - "x-internal": true, - "summary": "Info for a specific transaction", - "description": "Get a transaction by payload hash", - "operationId": "getTransactionByID", - "security": [ - { - "BearerAuth": [ - "transact" - ] - } - ], - "tags": [ - "guardian" - ], - "parameters": [ - { - "name": "transactionID", - "in": "path", - "required": true, - "description": "The id of the transaction to retrieve", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "chainType", - "schema": { - "type": "string", - "enum": [ - "evm" - ] - }, - "required": true, - "description": "roll up type" - }, - { - "in": "query", - "name": "chainID", - "schema": { - "type": "string" - }, - "description": "ID of evm chain" - } - ], - "responses": { - "200": { - "description": "Expected response to a valid request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Transaction" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - } - }, - "/guardian/v1/messages/{messageID}": { - "get": { - "x-internal": true, - "summary": "Info for a specific evm message", - "description": "Get an evm message by id", - "operationId": "getMessageByID", - "security": [ - { - "BearerAuth": [ - "transact" - ] - } - ], - "tags": [ - "guardian" - ], - "parameters": [ - { - "name": "messageID", - "in": "path", - "required": true, - "description": "The id of the evm message", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Expected response to a valid request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EVMMessage" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - } - }, - "/guardian/v1/erc191-messages/{messageID}": { - "get": { - "x-internal": true, - "summary": "Info for a specific erc191 message", - "description": "Get an erc191 message by id", - "operationId": "getErc191MessageByID", - "security": [ - { - "BearerAuth": [ - "transact" - ] - } - ], - "tags": [ - "guardian" - ], - "parameters": [ - { - "name": "messageID", - "in": "path", - "required": true, - "description": "The id of the erc191 message", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Expected response to a valid request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Erc191MessageResponse" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - } - }, - "/guardian/v1/session-activity-contracts": { - "get": { - "x-internal": true, - "summary": "Get session activity contracts", - "description": "Retrieve session activity contracts with optional filtering", - "tags": [ - "passport", - "guardian" - ], - "operationId": "getSessionActivityContracts", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } - ], - "parameters": [ - { - "name": "clientId", - "in": "query", - "required": false, - "description": "Filter by Passport client ID", - "schema": { - "type": "string" - } - }, - { - "name": "enabled", - "in": "query", - "required": false, - "description": "Filter by enabled status (true or false). If not provided, returns ALL records (enabled and disabled) - matching S3 behavior.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Session activity contracts retrieved successfully", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SessionActivityContractsResponse" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "429": { - "description": "TooManyRequestsError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError429" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - }, - "post": { - "x-internal": true, - "summary": "Create session activity contract", - "description": "Create a new session activity contract for tracking user interactions", - "tags": [ - "passport", - "guardian" - ], - "operationId": "createSessionActivityContract", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } - ], - "requestBody": { - "description": "The request body to create a session activity contract", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpsertSessionActivityContractReq" - } - } - } - }, - "responses": { - "201": { - "description": "Session activity contract created response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpsertSessionActivityContractResp" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "409": { - "description": "ConflictError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError409" - } - } - } - }, - "429": { - "description": "TooManyRequestsError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError429" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - } - }, - "/guardian/v1/session-activity-contracts/{id}": { - "get": { - "get": null, - "x-internal": true, - "summary": "Get session activity contract by id", - "description": "Get session activity contract by id", - "operationId": "getSessionActivityContract", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "The id of the session activity contract", - "schema": { - "type": "string" - } - } - ], - "tags": [ - "passport", - "guardian" - ], - "responses": { - "200": { - "description": "Expected response to a valid request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SessionActivityContractResponse" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - }, - "put": { - "x-internal": true, - "summary": "Update session activity contract", - "description": "Update a session activity contract", - "tags": [ - "passport", - "guardian" - ], - "operationId": "updateSessionActivityContract", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "description": "The id of the session activity contract", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "The request body to create a session activity contract", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpsertSessionActivityContractReq" - } - } - } - }, - "responses": { - "200": { - "description": "Session activity contract updated response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpsertSessionActivityContractResp" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "409": { - "description": "ConflictError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError409" - } - } - } - }, - "429": { - "description": "TooManyRequestsError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError429" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - }, - "delete": { - "tags": [ - "passport", - "guardian" - ], - "summary": "deletes session activities", - "x-internal": true, - "operationId": "deleteSessionActivityContract", - "security": [ - { - "OktaBearerAuth": [ - "retool_role_editor" - ] - } - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the session activity contract to be deleted", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "401": { - "description": "UnauthorizedError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - } - }, - "/guardian/v1/private/session-activity-contracts": { - "get": { - "x-internal": true, - "summary": "Get session activity contracts for private service to service communication", - "description": "Get session activity contracts mappings for private service to service communication", - "operationId": "getPrivateSessionActivityContracts", - "security": [], - "tags": [ - "passport", - "guardian" - ], - "responses": { - "200": { - "description": "Expected response to a valid request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SessionActivityContractsResponse" - } - } - } - }, - "400": { - "description": "BadRequestError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "403": { - "description": "ForbiddenError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "404": { - "description": "NotFoundError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "500": { - "description": "InternalServerError", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "default": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicAPIError" - } - } - } - } - } - } - }, - "/v1/chains/{chain_name}/search/filters/{contract_address}": { - "get": { - "tags": [ - "metadata-search" - ], - "operationId": "ListFilters", - "summary": "Get list of metadata attribute filters", - "description": "Get list of metadata filters", - "parameters": [ - { - "name": "chain_name", - "description": "The name of chain", - "schema": { - "$ref": "#/components/schemas/ChainName" - }, - "in": "path", - "required": true, - "examples": { - "testnet": { - "value": "imtbl-zkevm-testnet", - "summary": "Immutable zkEVM Public Testnet" - } - } - }, - { - "name": "contract_address", - "in": "path", - "required": true, - "description": "Contract addresses for collection", - "schema": { - "type": "string", - "pattern": "^0x[a-fA-F0-9]{40}$", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - } - } - ], - "responses": { - "200": { - "description": "200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ListFiltersResult" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/UnauthorisedRequest" - }, - "403": { - "$ref": "#/components/responses/ForbiddenRequest" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/InternalServerError" - } - } - } - }, - "/v1/chains/{chain_name}/search/nfts": { - "get": { - "tags": [ - "metadata-search" - ], - "operationId": "SearchNFTs", - "summary": "Search NFTs", - "description": "Search NFTs", - "parameters": [ - { - "name": "chain_name", - "description": "The name of chain", - "schema": { - "$ref": "#/components/schemas/ChainName" - }, - "in": "path", - "required": true, - "examples": { - "testnet": { - "value": "imtbl-zkevm-testnet", - "summary": "Immutable zkEVM Public Testnet" - } - } - }, - { - "name": "contract_address", - "in": "query", - "required": true, - "description": "List of contract addresses to filter by", - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^0x[a-fA-F0-9]{40}$", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "maxItems": 20, - "minItems": 1 - } - }, - { - "name": "account_address", - "in": "query", - "required": false, - "description": "Account address to filter by", - "schema": { - "type": "string", - "pattern": "^0x[a-fA-F0-9]{40}$", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - } - }, - { - "name": "stack_id", - "in": "query", - "required": false, - "description": "Filters NFTs that belong to any of these stacks", - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid", - "example": "7053e765-c119-4efb-b5cf-405ccccaf6c4" - }, - "minItems": 1, - "maxItems": 20 - } - }, - { - "name": "only_include_owner_listings", - "in": "query", - "required": false, - "description": "Whether the listings should include only the owner created listings", - "schema": { - "type": "boolean", - "example": true - } - }, - { - "name": "page_size", - "in": "query", - "required": false, - "description": "Number of results to return per page", - "schema": { - "$ref": "#/components/schemas/PageSize" - } - }, - { - "name": "page_cursor", - "in": "query", - "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/PageCursor" - } - } - ], - "responses": { - "200": { - "description": "200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchNFTsResult" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/UnauthorisedRequest" - }, - "403": { - "$ref": "#/components/responses/ForbiddenRequest" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/InternalServerError" - } - } - } - }, - "/v1/chains/{chain_name}/search/stacks": { - "get": { - "tags": [ - "metadata-search" - ], - "operationId": "SearchStacks", - "summary": "Search NFT stacks", - "description": "Search NFT stacks", - "parameters": [ - { - "name": "chain_name", - "description": "The name of chain", - "schema": { - "$ref": "#/components/schemas/ChainName" - }, - "in": "path", - "required": true, - "examples": { - "testnet": { - "value": "imtbl-zkevm-testnet", - "summary": "Immutable zkEVM Public Testnet" - } - } - }, - { - "name": "contract_address", - "in": "query", - "required": true, - "description": "List of contract addresses to filter by", - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^0x[a-fA-F0-9]{40}$", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "maxItems": 20, - "minItems": 1 - } - }, - { - "name": "account_address", - "in": "query", - "required": false, - "description": "Account address to filter by", - "schema": { - "type": "string", - "pattern": "^0x[a-fA-F0-9]{40}$", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - } - }, - { - "name": "only_include_owner_listings", - "in": "query", - "required": false, - "description": "Whether to the listings should include only the owner created listings", - "schema": { - "type": "boolean", - "example": true - } - }, - { - "name": "only_if_has_active_listings", - "in": "query", - "required": false, - "description": "Filters results to include only stacks that have a current active listing. False and 'null' return all unfiltered stacks.", - "schema": { - "type": "boolean", - "example": true - } - }, - { - "name": "traits", - "in": "query", - "required": false, - "description": "JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\"rarity\": {\"values\": [\"common\", \"rare\"], \"condition\": \"eq\"}}))", - "schema": { - "type": "string" - } - }, - { - "name": "keyword", - "in": "query", - "required": false, - "description": "Keyword to search NFT name and description. Alphanumeric characters only.", - "schema": { - "type": "string", - "example": "sword" - } - }, - { - "name": "payment_token", - "in": "query", - "required": false, - "description": "Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or 'NATIVE'", - "schema": { - "type": "string", - "example": "NATIVE" - } - }, - { - "name": "sort_by", - "in": "query", - "required": false, - "description": "Sort results in a specific order", - "schema": { - "type": "string", - "nullable": false, - "enum": [ - "cheapest_first" - ] - } - }, - { - "name": "page_size", - "in": "query", - "required": false, - "description": "Number of results to return per page", - "schema": { - "$ref": "#/components/schemas/PageSize" - } - }, - { - "name": "page_cursor", - "in": "query", - "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/PageCursor" - } - } - ], - "responses": { - "200": { - "description": "200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchStacksResult" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/UnauthorisedRequest" - }, - "403": { - "$ref": "#/components/responses/ForbiddenRequest" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/InternalServerError" - } - } - } - }, - "/v1/chains/{chain_name}/stacks": { - "get": { - "tags": [ - "metadata" - ], - "operationId": "ListStacks", - "summary": "List NFT stack bundles by stack_id. Response will include Market, Listings & Stack Count information for each stack", - "description": "List NFT stack bundles by stack_id. This endpoint functions similarly to `ListMetadataByID` but extends the response to include Market, Listings & Stack Count information for each stack.", - "parameters": [ - { - "name": "chain_name", - "description": "The name of chain", - "schema": { - "$ref": "#/components/schemas/ChainName" - }, - "in": "path", - "required": true, - "examples": { - "testnet": { - "value": "imtbl-zkevm-testnet", - "summary": "Immutable zkEVM Public Testnet" - } - } - }, - { - "name": "stack_id", - "in": "query", - "required": true, - "description": "List of stack_id to filter by", - "schema": { - "type": "array", - "items": { - "format": "uuid", - "type": "string", - "example": "7053e765-c119-4efb-b5cf-405ccccaf6c4" - }, - "maxItems": 20, - "minItems": 1 - } - } - ], - "responses": { - "200": { - "description": "200 response", - "content": { - "application/json": { - "schema": { - "type": "array", - "description": "List of stack bundles", - "items": { - "$ref": "#/components/schemas/StackBundle" - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/UnauthorisedRequest" - }, - "403": { - "$ref": "#/components/responses/ForbiddenRequest" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/InternalServerError" - } - } - } - }, - "/v1/chains/{chain_name}/quotes/{contract_address}/stacks": { - "get": { - "tags": [ - "pricing" - ], - "operationId": "QuotesForStacks", - "summary": "Get pricing data for a list of stack ids", - "description": "Get pricing data for a list of stack ids", - "parameters": [ - { - "name": "chain_name", - "description": "The name of chain", - "schema": { - "$ref": "#/components/schemas/ChainName" - }, - "in": "path", - "required": true, - "examples": { - "testnet": { - "value": "imtbl-zkevm-testnet", - "summary": "Immutable zkEVM Public Testnet" - } - } - }, - { - "name": "contract_address", - "in": "path", - "required": true, - "description": "Contract address for collection that these stacks are on", - "schema": { - "pattern": "^0x[a-fA-F0-9]{40}$", - "type": "string" - } - }, - { - "name": "stack_id", - "in": "query", - "required": true, - "description": "List of stack ids to get pricing data for", - "schema": { - "type": "array", - "items": { - "type": "string", - "format": "uuid", - "example": "7053e765-c119-4efb-b5cf-405ccccaf6c4" - }, - "minItems": 1, - "maxItems": 20 - } - }, - { - "name": "payment_token", - "in": "query", - "required": false, - "description": "Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or 'NATIVE'.", - "schema": { - "type": "string", - "example": "NATIVE" - } - }, - { - "name": "page_cursor", - "in": "query", - "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/PageCursor" - } - } - ], - "responses": { - "200": { - "description": "200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QuotesForStacksResult" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/UnauthorisedRequest" - }, - "403": { - "$ref": "#/components/responses/ForbiddenRequest" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/InternalServerError" - } - } - } - }, - "/v1/chains/{chain_name}/quotes/{contract_address}/nfts": { - "get": { - "tags": [ - "pricing" - ], - "operationId": "QuotesForNFTs", - "summary": "Get pricing data for a list of token ids", - "description": "pricing data for a list of token ids", - "parameters": [ - { - "name": "chain_name", - "description": "The name of chain", - "schema": { - "$ref": "#/components/schemas/ChainName" - }, - "in": "path", - "required": true, - "examples": { - "testnet": { - "value": "imtbl-zkevm-testnet", - "summary": "Immutable zkEVM Public Testnet" - } - } - }, - { - "name": "contract_address", - "in": "path", - "required": true, - "description": "Contract address for collection that these token ids are on", - "schema": { - "type": "string", - "pattern": "^0x[a-fA-F0-9]{40}$" - } - }, - { - "name": "token_id", - "in": "query", - "required": true, - "description": "List of token ids to get pricing data for", - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^\\d+$", - "example": "1337" - }, - "minItems": 1, - "maxItems": 20 - } - }, - { - "name": "payment_token", - "in": "query", - "required": false, - "description": "Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or 'NATIVE'.", - "schema": { - "type": "string", - "example": "NATIVE" - } - }, - { - "name": "page_cursor", - "in": "query", - "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", - "required": false, - "schema": { - "$ref": "#/components/schemas/PageCursor" - } - } - ], - "responses": { - "200": { - "description": "200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QuotesForNFTsResult" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/UnauthorisedRequest" - }, - "403": { - "$ref": "#/components/responses/ForbiddenRequest" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "429": { - "$ref": "#/components/responses/TooManyRequests" - }, - "500": { - "$ref": "#/components/responses/InternalServerError" - } - } - } - } - }, - "components": { - "securitySchemes": { - "BearerAuthWithClient": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "JWT" - }, - "BearerAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "JWT" - }, - "ImmutableApiKey": { - "x-go-name": "ImmutableApiKey", - "type": "apiKey", - "in": "header", - "name": "x-immutable-api-key" - }, - "OktaBearerAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "JWT" - } - }, - "parameters": { - "ChainName": { - "name": "chain_name", - "description": "The name of chain", - "in": "path", - "required": true, - "schema": { - "$ref": "#/components/schemas/ChainName" - }, - "examples": { - "testnet": { - "value": "imtbl-zkevm-testnet", - "summary": "Immutable zkEVM Public Testnet" - } - } - }, - "ContractAddress": { - "name": "contract_address", - "in": "path", - "required": true, - "description": "Contract address", - "schema": { - "$ref": "#/components/schemas/Address" - } - }, - "FeedItemIdParam": { - "name": "feed_item_id", - "in": "path", - "description": "Feed item ID", - "required": true, - "schema": { - "type": "string" - } - }, - "FeedItemAssetTypeParam": { - "name": "type", - "in": "query", - "description": "Asset type to be sent as a query param", - "required": true, - "schema": { - "type": "string", - "enum": [ - "image", - "video" - ] - } - }, - "PageCursorParam": { - "name": "page_cursor", - "in": "query", - "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response", - "required": false, - "schema": { - "$ref": "#/components/schemas/PageCursor" - } - }, - "Offset": { - "name": "offset", - "in": "query", - "description": "Offset for pagination", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "minimum": 0, - "default": 0, - "example": 10 - } - }, - "PageSizeParam": { - "name": "page_size", - "description": "Maximum number of items to return", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "minimum": 1, - "default": 100, - "maximum": 100, - "example": 10 - } - }, - "SortDirection": { - "name": "sort_direction", - "in": "query", - "description": "Ascending or descending direction for sort", - "required": false, - "schema": { - "enum": [ - "asc", - "desc" - ], - "type": "string" - } - }, - "SortField": { - "name": "sort_field", - "in": "query", - "description": "Field to sort by", - "required": false, - "schema": { - "enum": [ - "name", - "slug", - "lastPublished" - ], - "type": "string" - } - }, - "TransactionId": { - "name": "id", - "in": "path", - "description": "Transaction identifier: EVM transaction ID", - "required": true, - "schema": { - "type": "string", - "description": "Hash of the transaction" - } - } - }, - "responses": { - "NotFound": { - "description": "The specified resource was not found (404)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError404" - } - } - } - }, - "BadRequest": { - "description": "Bad Request (400)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError400" - } - } - } - }, - "UnauthorisedRequest": { - "description": "Unauthorised Request (401)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError401" - } - } - } - }, - "ForbiddenRequest": { - "description": "Forbidden Request (403)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError403" - } - } - } - }, - "Conflict": { - "description": "Conflict (409)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError409" - } - } - } - }, - "TooManyRequests": { - "description": "Too Many Requests (429)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError429" - } - } - }, - "headers": { - "Retry-After": { - "$ref": "#/components/headers/RetryAfter" - } - } - }, - "TooManyMetadataRefreshes": { - "description": "Too Many Metadata refreshes (429)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError429" - } - } - }, - "headers": { - "imx-refreshes-limit": { - "$ref": "#/components/headers/MetadataRefreshLimit" - }, - "imx-refresh-limit-reset": { - "$ref": "#/components/headers/MetadataRefreshLimitReset" - }, - "imx-remaining-refreshes": { - "$ref": "#/components/headers/MetadataRefreshLimitRemaining" - }, - "Retry-After": { - "$ref": "#/components/headers/MetadataRefreshRetryAfter" - } - } - }, - "TooManyMintRequests": { - "description": "Too Many mint requests (429)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError429" - } - } - }, - "headers": { - "imx-mint-requests-limit": { - "$ref": "#/components/headers/MintRequestsLimit" - }, - "imx-mint-requests-limit-reset": { - "$ref": "#/components/headers/MintRequestsLimitReset" - }, - "imx-remaining-mint-requests": { - "$ref": "#/components/headers/MintRequestsLimitRemaining" - }, - "imx-mint-requests-retry-after": { - "$ref": "#/components/headers/MintRequestsRetryAfter" - }, - "Retry-After": { - "$ref": "#/components/headers/MintRequestsRetryAfter" - } - } - }, - "InternalServerError": { - "description": "Internal Server Error (500)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError500" - } - } - } - }, - "NotImplementedError": { - "description": "Not Implemented Error (501)", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError501" - } - } - } - }, - "ServiceUnavailable": { - "description": "Service Unavailable (503) - RPC or upstream service temporarily unavailable", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError503" - } - } - } - }, - "GatewayTimeout": { - "description": "Gateway Timeout (504) - Upstream validation request timed out", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIError504" - } - } - } - } - }, - "headers": { - "MetadataRefreshLimit": { - "description": "The refresh request limit available to the project for each one-hour window.", - "schema": { - "type": "string" - } - }, - "MetadataRefreshLimitReset": { - "description": "The expiry date of the current one-hour window.", - "schema": { - "type": "string" - } - }, - "MetadataRefreshLimitRemaining": { - "description": "The number of refresh requests remaining in the current window.", - "schema": { - "type": "string" - } - }, - "MetadataRefreshRetryAfter": { - "description": "The number of seconds until the next refresh request can be made.", - "schema": { - "type": "string" - } - }, - "RetryAfter": { - "description": "The number of seconds until the next request can be made.", - "schema": { - "type": "string" - } - }, - "MintRequestsLimit": { - "description": "The mint requests limit available to the project for each time window.", - "schema": { - "type": "string" - } - }, - "MintRequestsLimitReset": { - "description": "The expiry date of the current time window.", - "schema": { - "type": "string" - } - }, - "MintRequestsLimitRemaining": { - "description": "The number of mint requests remaining in the current window.", - "schema": { - "type": "string" - } - }, - "MintRequestsRetryAfter": { - "description": "The number of seconds until the next refresh request can be made.", - "schema": { - "type": "string" - } - } - }, - "schemas": { - "PageSize": { - "type": "integer", - "format": "int32", - "description": "Maximum number of items to return", - "minimum": 1, - "default": 100, - "maximum": 200, - "example": 10 - }, - "PageCursor": { - "type": "string", - "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", - "example": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0=" - }, - "Page": { - "type": "object", - "description": "Pagination properties", - "properties": { - "previous_cursor": { - "type": "string", - "nullable": true, - "description": "First item as an encoded string", - "example": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0=" - }, - "next_cursor": { - "type": "string", - "nullable": true, - "description": "Last item as an encoded string", - "example": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0=" - } - }, - "required": [ - "previous_cursor", - "next_cursor" - ] - }, - "ActivityType": { - "description": "The activity type", - "example": "mint", - "type": "string", - "enum": [ - "mint", - "burn", - "transfer", - "sale", - "deposit", - "withdrawal" - ] - }, - "ActivityNFT": { - "type": "object", - "properties": { - "contract_type": { - "$ref": "#/components/schemas/NFTContractType" - }, - "contract_address": { - "description": "The token contract address", - "type": "string", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - "token_id": { - "description": "An `uint256` token id as string", - "type": "string", - "example": "1" - }, - "amount": { - "description": "(deprecated - will never be filled, use amount on Activity instead) The amount of tokens exchanged", - "type": "string", - "example": "1", - "deprecated": true - } - }, - "required": [ - "contract_type", - "contract_address", - "token_id", - "amount" - ] - }, - "ActivityToken": { - "type": "object", - "properties": { - "contract_type": { - "$ref": "#/components/schemas/TokenContractType" - }, - "contract_address": { - "description": "The contract address", - "type": "string", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - } - }, - "required": [ - "contract_type", - "contract_address" - ] - }, - "ActivityAsset": { - "description": "The contract and asset details for this activity", - "oneOf": [ - { - "$ref": "#/components/schemas/ActivityNFT" - }, - { - "$ref": "#/components/schemas/ActivityToken" - } - ], - "discriminator": { - "propertyName": "contract_type" - } - }, - "Address": { - "x-go-type": "common.Address", - "x-go-type-import": { - "path": "github.com/ethereum/go-ethereum/common", - "name": "common" - }, - "description": "An Ethereum address", - "type": "string", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, - "Mint": { - "type": "object", - "description": "The mint activity details", - "properties": { - "to": { - "description": "The account address the asset was minted to", - "type": "string", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "amount": { - "description": "The minted amount", - "type": "string", - "example": "1" - }, - "asset": { - "$ref": "#/components/schemas/ActivityAsset" - } - }, - "required": [ - "to", - "amount", - "asset" - ] - }, - "Deposit": { - "type": "object", - "description": "The deposit activity details", - "properties": { - "to": { - "description": "The account address the asset was deposited to", - "type": "string", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "amount": { - "description": "The deposited amount", - "type": "string", - "example": "1" - }, - "asset": { - "$ref": "#/components/schemas/ActivityAsset" - } - }, - "required": [ - "to", - "amount", - "asset" - ] - }, - "Burn": { - "description": "The burn activity details", - "type": "object", - "properties": { - "from": { - "description": "The account address the asset was transferred from", - "type": "string", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "amount": { - "description": "The amount of assets burnt", - "type": "string", - "example": "1" - }, - "asset": { - "$ref": "#/components/schemas/ActivityAsset" - } - }, - "required": [ - "from", - "amount", - "asset" - ] - }, - "Withdrawal": { - "description": "The withdrawal activity details", - "type": "object", - "properties": { - "from": { - "description": "The account address the asset was withdrawn from", - "type": "string", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "amount": { - "description": "The amount of assets withdrawn", - "type": "string", - "example": "1" - }, - "asset": { - "$ref": "#/components/schemas/ActivityAsset" - } - }, - "required": [ - "from", - "amount", - "asset" - ] - }, - "Transfer": { - "type": "object", - "description": "The transfer activity details", - "properties": { - "from": { - "description": "The account address the asset was transferred from", - "type": "string", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "to": { - "description": "The account address the asset was transferred to", - "type": "string", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "amount": { - "description": "The amount of assets transferred", - "type": "string", - "example": "1" - }, - "asset": { - "$ref": "#/components/schemas/ActivityAsset" - } - }, - "required": [ - "activity_type", - "from", - "to", - "amount", - "asset" - ] - }, - "ActivityNativeToken": { - "type": "object", - "properties": { - "symbol": { - "description": "The token symbol", - "type": "string", - "example": "ETH" - } - }, - "required": [ - "symbol" - ] - }, - "SalePayment": { - "type": "object", - "properties": { - "token": { - "description": "The type of payment token", - "oneOf": [ - { - "$ref": "#/components/schemas/ActivityToken" - }, - { - "$ref": "#/components/schemas/ActivityNativeToken" - } - ] - }, - "price_excluding_fees": { - "description": "The base price of the sale not including any fees", - "type": "string", - "example": "180" - }, - "price_including_fees": { - "description": "The total price of the sale. Includes the sum of all fees", - "type": "string", - "example": "200" - }, - "fees": { - "description": "The fees associated with this sale", - "type": "array", - "items": { - "$ref": "#/components/schemas/SaleFee" - }, - "example": [ - { - "address": "0xB0F3749458169B7Ad51B5503CC3649DE55c2D0D2", - "amount": "20", - "type": "ROYALTY" - } - ], - "minItems": 0 - } - }, - "required": [ - "token", - "price_excluding_fees", - "price_including_fees", - "fees" - ] - }, - "SaleFee": { - "type": "object", - "properties": { - "amount": { - "type": "string", - "description": "Fee payable to recipient upon settlement", - "example": "200" - }, - "type": { - "type": "string", - "description": "Fee type", - "example": "ROYALTY", - "enum": [ - "ROYALTY" - ] - }, - "recipient": { - "type": "string", - "description": "Wallet address of fee recipient", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233" - } - } - }, - "NFTSale": { - "description": "The NFT Sale activity details", - "type": "object", - "properties": { - "order_id": { - "description": "The id of order", - "type": "string", - "example": "ARZ3NDEKTSV4RRFFQ69G5FAV" - }, - "to": { - "description": "The account address of buyer", - "type": "string", - "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" - }, - "from": { - "description": "The account address of seller", - "type": "string", - "example": "0xbD6cFcf93474De653d7B42b346c7c25d1F9c559C" - }, - "asset": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ActivityNFT" - } - }, - "payment": { - "$ref": "#/components/schemas/SalePayment" - } - }, - "required": [ - "order_id", - "to", - "from", - "asset", - "payment" - ] - }, - "ActivityDetails": { - "description": "The activity details", - "oneOf": [ - { - "$ref": "#/components/schemas/Mint" - }, - { - "$ref": "#/components/schemas/Burn" - }, - { - "$ref": "#/components/schemas/Transfer" - }, - { - "$ref": "#/components/schemas/NFTSale" - }, - { - "$ref": "#/components/schemas/Deposit" - }, - { - "$ref": "#/components/schemas/Withdrawal" - } - ] - }, - "BlockchainMetadata": { - "description": "The metadata related to blockchain transaction", - "nullable": true, - "type": "object", - "properties": { - "transaction_hash": { - "type": "string", - "description": "The transaction hash of the activity", - "example": "0x68d9eac5e3b3c3580404989a4030c948a78e1b07b2b5ea5688d8c38a6c61c93e" - }, - "block_number": { - "description": "EVM block number (uint64 as string)", - "type": "string", - "example": "1" - }, - "transaction_index": { - "description": "Transaction index in a block (uint32 as string)", - "type": "string", - "example": "1" - }, - "log_index": { - "description": "The log index of activity in a block (uint32 as string)", - "type": "string", - "nullable": true, - "example": "1" - } - }, - "required": [ - "transaction_hash", - "block_number", - "transaction_index", - "log_index" - ] - }, - "Activity": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/ActivityID" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "type": { - "$ref": "#/components/schemas/ActivityType" - }, - "details": { - "$ref": "#/components/schemas/ActivityDetails" - }, - "updated_at": { - "type": "string", - "description": "The time activity was updated at", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z" - }, - "indexed_at": { - "type": "string", - "description": "The time activity was indexed", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z" - }, - "blockchain_metadata": { - "$ref": "#/components/schemas/BlockchainMetadata" - } - }, - "required": [ - "id", - "chain", - "type", - "details", - "indexed_at", - "updated_at", - "blockchain_metadata" - ] - }, - "ListActivitiesResult": { - "type": "object", - "description": "List activities response", - "properties": { - "result": { - "type": "array", - "description": "List of activities", - "items": { - "$ref": "#/components/schemas/Activity" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] - }, - "GetActivityResult": { - "type": "object", - "description": "Single activity", - "properties": { - "result": { - "$ref": "#/components/schemas/Activity" - } - }, - "required": [ - "result" - ] - }, - "Collection": { - "type": "object", - "properties": { - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "name": { - "type": "string", - "nullable": true, - "description": "The name of the collection", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - "symbol": { - "type": "string", - "nullable": true, - "description": "The symbol of contract", - "example": "BASP" - }, - "contract_type": { - "$ref": "#/components/schemas/CollectionContractType" - }, - "contract_address": { - "type": "string", - "description": "The address of the contract", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - "description": { - "type": "string", - "nullable": true, - "description": "The description of collection", - "example": "Some description" - }, - "image": { - "type": "string", - "description": "The url of the collection image", - "example": "https://some-url", - "nullable": true - }, - "external_link": { - "type": "string", - "description": "The url of external link", - "example": "https://some-url", - "nullable": true - }, - "contract_uri": { - "type": "string", - "description": "The uri for the metadata of the collection", - "example": "https://some-url", - "nullable": true - }, - "base_uri": { - "type": "string", - "nullable": true, - "description": "The metadata uri for nft", - "example": "https://some-url" - }, - "verification_status": { - "$ref": "#/components/schemas/AssetVerificationStatus" - }, - "indexed_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the collection was first indexed" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the collection was last updated" - }, - "metadata_synced_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the collection metadata was last synced" - } - }, - "required": [ - "chain", - "name", - "symbol", - "contract_type", - "contract_address", - "description", - "image", - "external_link", - "base_uri", - "metadata_uri", - "indexed_at", - "updated_at", - "metadata_synced_at", - "verification_status" - ] - }, - "ListCollectionsResult": { - "type": "object", - "properties": { - "result": { - "description": "List of collections", - "type": "array", - "items": { - "$ref": "#/components/schemas/Collection" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] - }, - "GetCollectionResult": { - "type": "object", - "description": "Single Collection", - "properties": { - "result": { - "$ref": "#/components/schemas/Collection" - } - }, - "required": [ - "result" - ] - }, - "GetMetadataResult": { - "type": "object", - "description": "Single metadata", - "properties": { - "result": { - "$ref": "#/components/schemas/Metadata" - } - }, - "required": [ - "result" - ] - }, - "ListMetadataResult": { - "type": "object", - "properties": { - "result": { - "description": "List of metadata", - "type": "array", - "items": { - "$ref": "#/components/schemas/Metadata" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] - }, - "Metadata": { - "type": "object", - "properties": { - "id": { - "$ref": "#/components/schemas/MetadataID" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "contract_address": { - "type": "string", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e", - "description": "The contract address of the metadata" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the metadata was created" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "When the metadata was last updated", - "example": "2022-08-16T17:43:26.991388Z" - }, - "name": { - "type": "string", - "nullable": true, - "example": "Sword", - "description": "The name of the NFT" - }, - "description": { - "type": "string", - "nullable": true, - "example": "2022-08-16T17:43:26.991388Z", - "description": "The description of the NFT" - }, - "image": { - "type": "string", - "nullable": true, - "description": "The image url of the NFT", - "example": "https://some-url" - }, - "external_url": { - "type": "string", - "nullable": true, - "description": "The external website link of NFT", - "example": "https://some-url" - }, - "animation_url": { - "type": "string", - "nullable": true, - "description": "The animation url of the NFT", - "example": "https://some-url" - }, - "youtube_url": { - "type": "string", - "nullable": true, - "description": "The youtube URL of NFT", - "example": "https://some-url" - }, - "attributes": { - "type": "array", - "description": "List of Metadata attributes", - "nullable": true, - "items": { - "$ref": "#/components/schemas/NFTMetadataAttribute" - } - } - }, - "required": [ - "id", - "chain", - "contract_address", - "created_at", - "updated_at", - "name", - "description", - "image", - "external_link", - "animation_url", - "youtube_url", - "attributes" - ] - }, - "RefreshMetadataByIDRequest": { - "type": "object", - "description": "Request body for refreshing metadata by id. Total size of this list should not exceed 228 KiB", - "properties": { - "metadata": { - "type": "array", - "maxItems": 10, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/RefreshMetadataByID" - } - } - }, - "required": [ - "metadata" - ] - }, - "NFT": { - "type": "object", - "properties": { - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "token_id": { - "type": "string", - "example": "1", - "description": "An `uint256` token id as string" - }, - "contract_address": { - "type": "string", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e", - "description": "The contract address of the NFT" - }, - "contract_type": { - "$ref": "#/components/schemas/NFTContractType" - }, - "indexed_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the NFT was first indexed" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the NFT owner was last updated" - }, - "metadata_synced_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "When NFT metadata was last synced", - "example": "2022-08-16T17:43:26.991388Z" - }, - "metadata_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "The id of the metadata of this NFT", - "example": "ae83bc80-4dd5-11ee-be56-0242ac120002" - }, - "name": { - "type": "string", - "nullable": true, - "example": "Sword", - "description": "The name of the NFT" - }, - "description": { - "type": "string", - "nullable": true, - "example": "2022-08-16T17:43:26.991388Z", - "description": "The description of the NFT" - }, - "image": { - "type": "string", - "nullable": true, - "description": "The image url of the NFT", - "example": "https://some-url" - }, - "external_link": { - "deprecated": true, - "type": "string", - "nullable": true, - "description": "(deprecated - use external_url instead) The external website link of NFT", - "example": "https://some-url" - }, - "external_url": { - "type": "string", - "nullable": true, - "description": "The external website link of NFT", - "example": "https://some-url" - }, - "animation_url": { - "type": "string", - "nullable": true, - "description": "The animation url of the NFT", - "example": "https://some-url" - }, - "youtube_url": { - "type": "string", - "nullable": true, - "description": "The youtube URL of NFT", - "example": "https://some-url" - }, - "attributes": { - "type": "array", - "description": "List of NFT Metadata attributes", - "items": { - "$ref": "#/components/schemas/NFTMetadataAttribute" - } - }, - "total_supply": { - "type": "string", - "nullable": true, - "description": "The total supply of NFT", - "example": "100" - } - }, - "required": [ - "chain", - "token_id", - "contract_address", - "indexed_at", - "updated_at", - "metadata_synced_at", - "name", - "description", - "image", - "external_link", - "external_url", - "animation_url", - "youtube_url", - "attributes", - "contract_type" - ] - }, - "NFTWithBalance": { - "type": "object", - "properties": { - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "token_id": { - "type": "string", - "example": "1", - "description": "An `uint256` token id as string" - }, - "contract_address": { - "type": "string", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e", - "description": "The contract address of the NFT" - }, - "contract_type": { - "$ref": "#/components/schemas/NFTContractType" - }, - "indexed_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the NFT was first indexed" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the NFT owner was last updated" - }, - "metadata_synced_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "When NFT metadata was last synced", - "example": "2022-08-16T17:43:26.991388Z" - }, - "metadata_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "The id of the metadata of this NFT", - "example": "ae83bc80-4dd5-11ee-be56-0242ac120002" - }, - "name": { - "type": "string", - "nullable": true, - "description": "The name of the NFT", - "example": "Sword" - }, - "description": { - "type": "string", - "nullable": true, - "description": "The description of the NFT", - "example": "This is a super awesome sword" - }, - "image": { - "type": "string", - "nullable": true, - "description": "The image url of the NFT", - "example": "https://some-url" - }, - "external_link": { - "type": "string", - "nullable": true, - "description": "The external website link of NFT", - "example": "https://some-url" - }, - "animation_url": { - "type": "string", - "nullable": true, - "description": "The animation url of the NFT", - "example": "https://some-url" - }, - "youtube_url": { - "type": "string", - "nullable": true, - "description": "The youtube URL of NFT", - "example": "https://some-url" - }, - "attributes": { - "type": "array", - "description": "List of Metadata attributes", - "nullable": false, - "items": { - "$ref": "#/components/schemas/NFTMetadataAttribute" - } - }, - "balance": { - "type": "string", - "nullable": false, - "description": "The amount of this NFT this account owns", - "example": "11" - } - }, - "required": [ - "chain", - "token_id", - "contract_address", - "indexed_at", - "updated_at", - "metadata_synced_at", - "name", - "description", - "image", - "external_link", - "animation_url", - "youtube_url", - "balance", - "contract_type", - "attributes" - ] - }, - "NFTMetadataAttribute": { - "type": "object", - "properties": { - "display_type": { - "description": "Display type for this attribute", - "type": "string", - "nullable": true, - "enum": [ - "number", - "boost_percentage", - "boost_number", - "date" - ], - "example": "number" - }, - "trait_type": { - "description": "The metadata trait type", - "type": "string", - "example": "Aqua Power" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "description": "The metadata trait value", - "example": "Happy" - } - }, - "required": [ - "trait_type", - "value" - ] - }, - "ChainName": { - "type": "string", - "description": "The name of chain", - "example": "imtbl-zkevm-testnet" - }, - "ActivityID": { - "description": "Activity id in UUIDv4 format", - "type": "string", - "format": "uuid", - "example": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b" - }, - "MetadataID": { - "description": "Metadata id in UUIDv4 format", - "type": "string", - "format": "uuid", - "example": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b" - }, - "CollectionContractType": { - "description": "The collection contract type", - "type": "string", - "enum": [ - "ERC721", - "ERC1155" - ] - }, - "NFTContractType": { - "description": "The contract type for an NFT", - "type": "string", - "enum": [ - "ERC721", - "ERC1155" - ] - }, - "TokenContractType": { - "description": "The contract type for a token", - "type": "string", - "enum": [ - "ERC20" - ] - }, - "AssetVerificationStatus": { - "description": "The verification status for a given contract", - "type": "string", - "enum": [ - "verified", - "unverified", - "spam", - "inactive" - ] - }, - "VerificationRequestStatus": { - "description": "The status of the verification request", - "type": "string", - "enum": [ - "completed", - "pending" - ] - }, - "GetNFTResult": { - "type": "object", - "description": "Single NFT", - "properties": { - "result": { - "$ref": "#/components/schemas/NFT" - } - }, - "required": [ - "result" - ] - }, - "ListNFTsResult": { - "type": "object", - "properties": { - "result": { - "description": "List of NFTs", - "type": "array", - "items": { - "$ref": "#/components/schemas/NFT" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] - }, - "ListNFTsByOwnerResult": { - "type": "object", - "properties": { - "result": { - "description": "List of NFTs by owner", - "type": "array", - "items": { - "$ref": "#/components/schemas/NFTWithBalance" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] - }, - "NFTOwner": { - "type": "object", - "properties": { - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "contract_address": { - "type": "string", - "description": "The address of NFT contract", - "example": "0x5a019874f4fae314b0eaa4606be746366e661306" - }, - "token_id": { - "type": "string", - "description": "An `uint256` token id as string", - "example": "1" - }, - "account_address": { - "type": "string", - "description": "The account address of the owner of the NFT", - "example": "0x5a019874f4fae314b0eaa4606be746366e661306" - }, - "balance": { - "type": "string", - "description": "The amount of owned tokens (uint256 as string)", - "example": "1" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the NFT owner was last updated" - } - }, - "required": [ - "chain", - "contract_address", - "token_id", - "account_address", - "balance" - ] - }, - "NFTWithOwner": { - "type": "object", - "properties": { - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "contract_address": { - "type": "string", - "description": "The address of NFT contract", - "example": "0x5a019874f4fae314b0eaa4606be746366e661306" - }, - "token_id": { - "type": "string", - "description": "An `uint256` token id as string", - "example": "1" - }, - "account_address": { - "type": "string", - "description": "The account address of the owner of the NFT", - "example": "0x5a019874f4fae314b0eaa4606be746366e661306" - }, - "balance": { - "type": "string", - "description": "The amount of owned tokens (uint256 as string)", - "example": "1" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the owner last changed for the given NFT" - } - }, - "required": [ - "chain", - "contract_address", - "token_id", - "account_address", - "balance", - "updated_at" - ] - }, - "GetTokenResult": { - "type": "object", - "description": "Single Token", - "properties": { - "result": { - "$ref": "#/components/schemas/Token" - } - }, - "required": [ - "result" - ] - }, - "ListNFTOwnersResult": { - "type": "object", - "properties": { - "result": { - "description": "List of nft owners", - "type": "array", - "items": { - "$ref": "#/components/schemas/NFTOwner" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] + } + } + }, + "headers": { + "MetadataRefreshLimit": { + "description": "The refresh request limit available to the project for each one-hour window.", + "schema": { + "type": "string" + } }, - "ListCollectionOwnersResult": { - "type": "object", - "properties": { - "result": { - "description": "List of NFT owners", - "type": "array", - "items": { - "$ref": "#/components/schemas/NFTWithOwner" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] + "MetadataRefreshLimitReset": { + "description": "The expiry date of the current one-hour window.", + "schema": { + "type": "string" + } }, - "ChainWithDetails": { - "allOf": [ - { - "$ref": "#/components/schemas/Chain" - }, - { - "type": "object", - "properties": { - "rpc_url": { - "type": "string", - "nullable": true, - "description": "URL for RPC node" - }, - "operator_allowlist_address": { - "type": "string", - "nullable": true, - "description": "The address of the Operator Allowlist - https://docs.immutable.com/products/zkevm/minting/royalties/allowlist-spec/" - }, - "minter_address": { - "type": "string", - "nullable": true, - "description": "The address of the minter used in the Minting API - https://docs.immutable.com/products/zkEVM/minting/minting-api#minting-api-prerequisites" - } - }, - "required": [ - "rpc_url", - "operator_allowlist_address", - "minter_address" - ] - } - ] + "MetadataRefreshLimitRemaining": { + "description": "The number of refresh requests remaining in the current window.", + "schema": { + "type": "string" + } }, - "Chain": { - "type": "object", - "description": "The chain details", - "properties": { - "id": { - "type": "string", - "description": "The id of chain", - "example": "eip155:13372" - }, - "name": { - "type": "string", - "description": "The name of chain", - "example": "imtbl-zkevm-testnet" - } - }, - "required": [ - "id", - "name" - ] + "MetadataRefreshRetryAfter": { + "description": "The number of seconds until the next refresh request can be made.", + "schema": { + "type": "string" + } }, - "ListChainsResult": { - "type": "object", - "properties": { - "result": { - "type": "array", - "description": "List of chains", - "items": { - "$ref": "#/components/schemas/ChainWithDetails" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] + "RetryAfter": { + "description": "The number of seconds until the next request can be made.", + "schema": { + "type": "string" + } }, - "ListTokensResult": { - "type": "object", - "properties": { - "result": { - "type": "array", - "description": "List of tokens", - "items": { - "$ref": "#/components/schemas/Token" - } - }, - "page": { - "$ref": "#/components/schemas/Page" - } - }, - "required": [ - "result", - "page" - ] + "MintRequestsLimit": { + "description": "The mint requests limit available to the project for each time window.", + "schema": { + "type": "string" + } }, - "RefreshMetadataByID": { - "allOf": [ - { - "$ref": "#/components/schemas/RefreshableNFTAttributes" - }, - { - "type": "object", - "properties": { - "metadata_id": { - "$ref": "#/components/schemas/MetadataID" - } - }, - "required": [ - "metadata_id" - ] - } - ] + "MintRequestsLimitReset": { + "description": "The expiry date of the current time window.", + "schema": { + "type": "string" + } }, - "RefreshMetadataByTokenID": { - "allOf": [ - { - "$ref": "#/components/schemas/RefreshableNFTAttributes" - }, - { - "type": "object", - "properties": { - "token_id": { - "type": "string", - "description": "An `uint256` token id as string", - "example": "1" - } - }, - "required": [ - "token_id" - ] - } - ] + "MintRequestsLimitRemaining": { + "description": "The number of mint requests remaining in the current window.", + "schema": { + "type": "string" + } }, - "RefreshableNFTAttributes": { - "allOf": [ - { - "$ref": "#/components/schemas/NFTMetadataRequest" - } - ], - "required": [ - "name", - "description", - "image", - "external_url", - "animation_url", - "youtube_url", - "attributes" - ] + "MintRequestsRetryAfter": { + "description": "The number of seconds until the next refresh request can be made.", + "schema": { + "type": "string" + } + } + }, + "schemas": { + "PageSize": { + "type": "integer", + "format": "int32", + "description": "Maximum number of items to return", + "minimum": 1, + "default": 100, + "maximum": 200, + "example": 10 }, - "NFTMetadataRequest": { + "PageCursor": { + "type": "string", + "description": "Encoded page cursor to retrieve previous or next page. Use the value returned in the response.", + "example": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0=" + }, + "Page": { "type": "object", - "description": "The NFT metadata. Total size of this object should not exceed 16 KiB", + "description": "Pagination properties", "properties": { - "name": { - "type": "string", - "nullable": true, - "example": "Sword", - "description": "The name of the NFT" - }, - "description": { - "type": "string", - "nullable": true, - "example": "2022-08-16T17:43:26.991388Z", - "description": "The description of the NFT" - }, - "image": { - "type": "string", - "nullable": true, - "description": "The image url of the NFT", - "example": "https://some-url" - }, - "external_url": { - "type": "string", - "nullable": true, - "description": "The external link of the NFT", - "example": "https://some-url" - }, - "animation_url": { + "previous_cursor": { "type": "string", "nullable": true, - "description": "The animation url of the NFT", - "example": "https://some-url" + "description": "First item as an encoded string", + "example": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0=" }, - "youtube_url": { + "next_cursor": { "type": "string", "nullable": true, - "description": "The youtube link of the NFT", - "example": "https://some-url" - }, - "attributes": { - "type": "array", - "description": "List of Metadata attributes", - "nullable": true, - "items": { - "$ref": "#/components/schemas/NFTMetadataAttribute" - } - } - } - }, - "RefreshNFTMetadataByTokenIDRequest": { - "type": "object", - "properties": { - "nft_metadata": { - "type": "array", - "description": "List of nft metadata to be refreshed. Total size of the list should not exceed 228 KiB", - "maxItems": 250, - "minItems": 1, - "items": { - "$ref": "#/components/schemas/RefreshMetadataByTokenID" - } + "description": "Last item as an encoded string", + "example": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0=" } }, "required": [ - "nft_metadata" + "previous_cursor", + "next_cursor" ] }, - "Token": { + "ActivityType": { + "description": "The activity type", + "example": "mint", + "type": "string", + "enum": [ + "mint", + "burn", + "transfer", + "sale", + "deposit", + "withdrawal" + ] + }, + "ActivityNFT": { "type": "object", "properties": { - "chain": { - "$ref": "#/components/schemas/Chain" + "contract_type": { + "$ref": "#/components/schemas/NFTContractType" }, "contract_address": { + "description": "The token contract address", "type": "string", - "description": "The address of token contract", - "example": "0xc344c05eef8876e517072f879dae8905aa2b956b" - }, - "root_contract_address": { - "type": "string", - "description": "The address of root token contract", - "example": "0x43e60b30d5bec48c0f5890e3d1e9f1b1296bb4aa", - "nullable": true - }, - "root_chain_id": { - "type": "string", - "description": "The id of the root chain for a bridged token", - "example": "eip155:1", - "nullable": true - }, - "bridge_used": { - "type": "string", - "description": "The name of the bridge, for bridged tokens only", - "example": "axelar", - "nullable": true - }, - "symbol": { - "type": "string", - "description": "The symbol of token", - "example": "AAA", - "nullable": true - }, - "decimals": { - "type": "integer", - "description": "The decimals of token", - "example": 18, - "nullable": true - }, - "image_url": { - "type": "string", - "description": "The image url of token", - "example": "https://some-url", - "nullable": true + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "name": { + "token_id": { + "description": "An `uint256` token id as string", "type": "string", - "description": "The name of token", - "example": "Token A", - "nullable": true - }, - "verification_status": { - "$ref": "#/components/schemas/AssetVerificationStatus" + "example": "1" }, - "updated_at": { + "amount": { + "description": "(deprecated - will never be filled, use amount on Activity instead) The amount of tokens exchanged", "type": "string", - "format": "date-time", - "example": "2022-08-16T17:43:26.991388Z", - "description": "When the collection was last updated" - }, - "is_canonical": { - "type": "boolean", - "example": true, - "description": "Indicates whether the token is canonical or not" + "example": "1", + "deprecated": true } }, "required": [ - "chain", + "contract_type", "contract_address", - "root_contract_address", - "symbol", - "decimals", - "image_url", - "name", - "updated_at", - "verification_status", - "is_canonical" + "token_id", + "amount" ] }, - "CollectionMetadata": { + "ActivityToken": { "type": "object", "properties": { - "name": { - "type": "string", - "nullable": true, - "description": "The name of the collection", - "example": "Gigantic Lizards" + "contract_type": { + "$ref": "#/components/schemas/TokenContractType" }, - "symbol": { + "contract_address": { + "description": "The contract address", "type": "string", - "nullable": true, - "description": "The symbol of contract", - "example": "GLZ" + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" + } + }, + "required": [ + "contract_type", + "contract_address" + ] + }, + "ActivityAsset": { + "description": "The contract and asset details for this activity", + "oneOf": [ + { + "$ref": "#/components/schemas/ActivityNFT" }, - "description": { + { + "$ref": "#/components/schemas/ActivityToken" + } + ], + "discriminator": { + "propertyName": "contract_type" + } + }, + "Address": { + "x-go-type": "common.Address", + "x-go-type-import": { + "path": "github.com/ethereum/go-ethereum/common", + "name": "common" + }, + "description": "An Ethereum address", + "type": "string", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3", + "pattern": "^0x[a-fA-F0-9]{40}$" + }, + "Mint": { + "type": "object", + "description": "The mint activity details", + "properties": { + "to": { + "description": "The account address the asset was minted to", "type": "string", - "nullable": true, - "description": "The description of collection", - "example": "This is the Gigantic Lizards collection" + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" }, - "image": { + "amount": { + "description": "The minted amount", "type": "string", - "description": "The url of the collection image", - "example": "https://some-url", - "nullable": true + "example": "1" }, - "external_link": { + "asset": { + "$ref": "#/components/schemas/ActivityAsset" + } + }, + "required": [ + "to", + "amount", + "asset" + ] + }, + "Deposit": { + "type": "object", + "description": "The deposit activity details", + "properties": { + "to": { + "description": "The account address the asset was deposited to", "type": "string", - "description": "The url of external link", - "example": "https://some-url", - "nullable": true + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" }, - "contract_uri": { + "amount": { + "description": "The deposited amount", "type": "string", - "description": "The uri for the metadata of the collection", - "example": "https://some-url", - "nullable": true + "example": "1" }, - "base_uri": { - "type": "string", - "nullable": true, - "description": "The metadata uri for nft", - "example": "https://some-url" + "asset": { + "$ref": "#/components/schemas/ActivityAsset" } }, "required": [ - "name", - "image", - "symbol", - "description", - "base_uri", - "external_link", - "contract_uri" + "to", + "amount", + "asset" ] }, - "RefreshCollectionMetadataRequest": { + "Burn": { + "description": "The burn activity details", "type": "object", "properties": { - "collection_metadata": { - "$ref": "#/components/schemas/CollectionMetadata" + "from": { + "description": "The account address the asset was transferred from", + "type": "string", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" + }, + "amount": { + "description": "The amount of assets burnt", + "type": "string", + "example": "1" + }, + "asset": { + "$ref": "#/components/schemas/ActivityAsset" } }, "required": [ - "collection_metadata" + "from", + "amount", + "asset" ] }, - "RefreshCollectionMetadataResult": { + "Withdrawal": { + "description": "The withdrawal activity details", "type": "object", "properties": { - "contract_address": { - "type": "string" + "from": { + "description": "The account address the asset was withdrawn from", + "type": "string", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" }, - "chain": { - "$ref": "#/components/schemas/Chain" + "amount": { + "description": "The amount of assets withdrawn", + "type": "string", + "example": "1" }, - "collection_metadata": { - "$ref": "#/components/schemas/CollectionMetadata" + "asset": { + "$ref": "#/components/schemas/ActivityAsset" } }, "required": [ - "contract_address", - "chain", - "collection_metadata" + "from", + "amount", + "asset" ] }, - "MetadataRefreshRateLimitResult": { + "Transfer": { "type": "object", + "description": "The transfer activity details", "properties": { - "imx_refreshes_limit": { - "type": "string" + "from": { + "description": "The account address the asset was transferred from", + "type": "string", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" }, - "imx_refresh_limit_reset": { - "type": "string" + "to": { + "description": "The account address the asset was transferred to", + "type": "string", + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" }, - "imx_remaining_refreshes": { - "type": "string" + "amount": { + "description": "The amount of assets transferred", + "type": "string", + "example": "1" }, - "retry_after": { - "type": "string" + "asset": { + "$ref": "#/components/schemas/ActivityAsset" } }, "required": [ - "imx_refreshes_limit", - "imx_refresh_limit_reset", - "imx_remaining_refreshes", - "retry_after" + "activity_type", + "from", + "to", + "amount", + "asset" ] }, - "CreateMintRequestRequest": { + "ActivityNativeToken": { "type": "object", "properties": { - "assets": { - "type": "array", - "maxItems": 100, - "minItems": 1, - "description": "List of nft to be minted", - "items": { - "$ref": "#/components/schemas/MintAsset" - } + "symbol": { + "description": "The token symbol", + "type": "string", + "example": "ETH" } }, "required": [ - "assets" + "symbol" ] }, - "VerificationRequestInternal": { - "description": "The verification request (internal)", - "allOf": [ - { - "$ref": "#/components/schemas/VerificationRequest" - }, - { - "type": "object", - "properties": { - "org_tier": { - "$ref": "#/components/schemas/OrganisationTier" + "SalePayment": { + "type": "object", + "properties": { + "token": { + "description": "The type of payment token", + "oneOf": [ + { + "$ref": "#/components/schemas/ActivityToken" + }, + { + "$ref": "#/components/schemas/ActivityNativeToken" } - }, - "required": [ - "org_tier" ] + }, + "price_excluding_fees": { + "description": "The base price of the sale not including any fees", + "type": "string", + "example": "180" + }, + "price_including_fees": { + "description": "The total price of the sale. Includes the sum of all fees", + "type": "string", + "example": "200" + }, + "fees": { + "description": "The fees associated with this sale", + "type": "array", + "items": { + "$ref": "#/components/schemas/SaleFee" + }, + "example": [ + { + "address": "0xB0F3749458169B7Ad51B5503CC3649DE55c2D0D2", + "amount": "20", + "type": "ROYALTY" + } + ], + "minItems": 0 } + }, + "required": [ + "token", + "price_excluding_fees", + "price_including_fees", + "fees" ] }, - "VerificationRequest": { - "description": "The verification request", + "SaleFee": { "type": "object", "properties": { - "id": { - "description": "The id of the verification request", - "type": "string", - "format": "uuid", - "example": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b" - }, - "chain": { - "$ref": "#/components/schemas/Chain" - }, - "contract_address": { - "description": "The contract address", - "type": "string", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - "org_name": { - "description": "The name of the organisation associated with this contract", - "nullable": true, + "amount": { "type": "string", - "example": "Immutable" + "description": "Fee payable to recipient upon settlement", + "example": "200" }, - "name": { + "type": { "type": "string", - "nullable": true, - "description": "The name of the collection", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" + "description": "Fee type", + "example": "ROYALTY", + "enum": [ + "ROYALTY" + ] }, - "symbol": { + "recipient": { "type": "string", - "nullable": true, - "description": "The symbol of contract", - "example": "BASP" - }, - "description": { + "description": "Wallet address of fee recipient", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233" + } + } + }, + "NFTSale": { + "description": "The NFT Sale activity details", + "type": "object", + "properties": { + "order_id": { + "description": "The id of order", "type": "string", - "nullable": true, - "description": "The description of collection", - "example": "Some description" + "example": "ARZ3NDEKTSV4RRFFQ69G5FAV" }, - "org_id": { + "to": { + "description": "The account address of buyer", "type": "string", - "nullable": true, - "description": "The id of the organisation associated with this contract", - "example": "753da67a-5d3b-42c7-b87a-eba3d17a6362" + "example": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3" }, - "requester_email": { + "from": { + "description": "The account address of seller", "type": "string", - "nullable": true, - "description": "The email address of the user who requested the contract to be verified", - "example": "user@immutable.com" + "example": "0xbD6cFcf93474De653d7B42b346c7c25d1F9c559C" }, - "contract_type": { - "$ref": "#/components/schemas/VerificationRequestContractType" + "asset": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ActivityNFT" + } }, - "verification_request_status": { - "$ref": "#/components/schemas/VerificationRequestStatus" + "payment": { + "$ref": "#/components/schemas/SalePayment" } }, "required": [ - "id", - "chain", - "contract_address", - "name", - "symbol", - "description", - "contract_type", - "org_name", - "org_id", - "requester_email", - "verification_request_status" + "order_id", + "to", + "from", + "asset", + "payment" ] }, - "VerificationRequestContractType": { - "description": "The contract type associated with the given request", - "type": "string", - "enum": [ - "ERC20", - "ERC721", - "ERC1155" + "ActivityDetails": { + "description": "The activity details", + "oneOf": [ + { + "$ref": "#/components/schemas/Mint" + }, + { + "$ref": "#/components/schemas/Burn" + }, + { + "$ref": "#/components/schemas/Transfer" + }, + { + "$ref": "#/components/schemas/NFTSale" + }, + { + "$ref": "#/components/schemas/Deposit" + }, + { + "$ref": "#/components/schemas/Withdrawal" + } ] }, - "OrganisationTier": { - "description": "The tier of the organisation", - "type": "string", + "BlockchainMetadata": { + "description": "The metadata related to blockchain transaction", "nullable": true, - "enum": [ - "common", - "uncommon", - "rare", - "epic", - "legendary" - ] - }, - "MintAsset": { "type": "object", "properties": { - "reference_id": { + "transaction_hash": { "type": "string", - "description": "The id of this asset in the system that originates the mint request", - "example": "67f7d464-b8f0-4f6a-9a3b-8d3cb4a21af0" + "description": "The transaction hash of the activity", + "example": "0x68d9eac5e3b3c3580404989a4030c948a78e1b07b2b5ea5688d8c38a6c61c93e" }, - "owner_address": { + "block_number": { + "description": "EVM block number (uint64 as string)", "type": "string", - "description": "The address of the receiver", - "example": "0xc344c05eef8876e517072f879dae8905aa2b956b" + "example": "1" }, - "token_id": { + "transaction_index": { + "description": "Transaction index in a block (uint32 as string)", "type": "string", - "description": "An optional `uint256` token id as string. Required for ERC1155 collections.", - "example": "1", - "nullable": true + "example": "1" }, - "amount": { + "log_index": { + "description": "The log index of activity in a block (uint32 as string)", "type": "string", - "description": "Optional mount of tokens to mint. Required for ERC1155 collections. ERC712 collections can omit this field or set it to 1", - "example": "1", "nullable": true, - "minLength": 1 - }, - "metadata": { - "$ref": "#/components/schemas/NFTMetadataRequest" + "example": "1" } }, "required": [ - "reference_id", - "owner_address" + "transaction_hash", + "block_number", + "transaction_index", + "log_index" ] }, - "CreateMintRequestResult": { + "Activity": { "type": "object", "properties": { - "imx_mint_requests_limit": { - "type": "string" + "id": { + "$ref": "#/components/schemas/ActivityID" }, - "imx_mint_requests_limit_reset": { - "type": "string" + "chain": { + "$ref": "#/components/schemas/Chain" }, - "imx_remaining_mint_requests": { - "type": "string" + "type": { + "$ref": "#/components/schemas/ActivityType" }, - "imx_mint_requests_retry_after": { - "type": "string" + "details": { + "$ref": "#/components/schemas/ActivityDetails" + }, + "updated_at": { + "type": "string", + "description": "The time activity was updated at", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z" + }, + "indexed_at": { + "type": "string", + "description": "The time activity was indexed", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z" + }, + "blockchain_metadata": { + "$ref": "#/components/schemas/BlockchainMetadata" } }, "required": [ - "imx_mint_requests_limit", - "imx_mint_requests_limit_reset", - "imx_remaining_mint_requests", - "imx_mint_requests_retry_after" + "id", + "chain", + "type", + "details", + "indexed_at", + "updated_at", + "blockchain_metadata" ] }, - "ListMintRequestsResult": { + "ListActivitiesResult": { "type": "object", - "description": "List mint requests", + "description": "List activities response", "properties": { "result": { "type": "array", - "description": "List of mint requests", + "description": "List of activities", "items": { - "$ref": "#/components/schemas/GetMintRequestResult" + "$ref": "#/components/schemas/Activity" } }, "page": { @@ -11470,6059 +7360,6266 @@ "page" ] }, - "GetMintRequestResult": { + "GetActivityResult": { + "type": "object", + "description": "Single activity", + "properties": { + "result": { + "$ref": "#/components/schemas/Activity" + } + }, + "required": [ + "result" + ] + }, + "Collection": { "type": "object", "properties": { "chain": { "$ref": "#/components/schemas/Chain" }, - "collection_address": { + "name": { "type": "string", - "description": "The address of the contract", + "nullable": true, + "description": "The name of the collection", "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "reference_id": { + "symbol": { "type": "string", - "description": "The reference id of this mint request" + "nullable": true, + "description": "The symbol of contract", + "example": "BASP" }, - "owner_address": { + "contract_type": { + "$ref": "#/components/schemas/CollectionContractType" + }, + "contract_address": { "type": "string", - "description": "The address of the owner of the NFT" + "description": "The address of the contract", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "token_id": { + "description": { "type": "string", - "example": "1", "nullable": true, - "description": "An `uint256` token id as string. Only available when the mint request succeeds" + "description": "The description of collection", + "example": "Some description" }, - "amount": { + "image": { "type": "string", - "example": "1", - "nullable": true, - "description": "An `uint256` amount as string. Only relevant for mint requests on ERC1155 contracts" + "description": "The url of the collection image", + "example": "https://some-url", + "nullable": true }, - "activity_id": { + "external_link": { "type": "string", - "format": "uuid", - "example": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b", - "nullable": true, - "description": "The id of the mint activity associated with this mint request" + "description": "The url of external link", + "example": "https://some-url", + "nullable": true }, - "transaction_hash": { + "contract_uri": { + "type": "string", + "description": "The uri for the metadata of the collection", + "example": "https://some-url", + "nullable": true + }, + "base_uri": { "type": "string", "nullable": true, - "description": "The transaction hash of the activity", - "example": "0x68d9eac5e3b3c3580404989a4030c948a78e1b07b2b5ea5688d8c38a6c61c93e" + "description": "The metadata uri for nft", + "example": "https://some-url" }, - "created_at": { + "verification_status": { + "$ref": "#/components/schemas/AssetVerificationStatus" + }, + "indexed_at": { "type": "string", "format": "date-time", "example": "2022-08-16T17:43:26.991388Z", - "description": "When the mint request was created" + "description": "When the collection was first indexed" }, "updated_at": { "type": "string", "format": "date-time", - "description": "When the mint request was last updated", - "example": "2022-08-16T17:43:26.991388Z" - }, - "error": { - "$ref": "#/components/schemas/MintRequestErrorMessage" + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the collection was last updated" }, - "status": { - "$ref": "#/components/schemas/MintRequestStatus" + "metadata_synced_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the collection metadata was last synced" } }, "required": [ "chain", - "collection_address", - "reference_id", - "owner_address", - "status", - "token_id", - "transaction_hash", - "error", - "created_at", - "updated_at" + "name", + "symbol", + "contract_type", + "contract_address", + "description", + "image", + "external_link", + "base_uri", + "metadata_uri", + "indexed_at", + "updated_at", + "metadata_synced_at", + "verification_status" ] }, - "MintRequestErrorMessage": { + "ListCollectionsResult": { "type": "object", - "description": "The error details in case the mint request fails", - "nullable": true, - "properties": { - "message": { - "description": "An error message in case the mint request fails", - "type": "string" - } - } - }, - "MintRequestStatus": { - "description": "The status of the mint request", - "example": "pending", - "type": "string", - "enum": [ - "pending", - "succeeded", - "failed" - ] - }, - "OperatorAllowlistStatus": { - "description": "The status of a contract on the operator allowlist", - "example": "requested", - "type": "string", - "enum": [ - "requested", - "approved", - "rejected", - "removed", - "added" - ] - }, - "OperatorAllowlistStatusDetails": { - "description": "The operator allowlist status details", - "oneOf": [ - { - "$ref": "#/components/schemas/OperatorAllowlistStatusRequested" + "properties": { + "result": { + "description": "List of collections", + "type": "array", + "items": { + "$ref": "#/components/schemas/Collection" + } }, - { - "$ref": "#/components/schemas/OperatorAllowlistStatusUpdated" + "page": { + "$ref": "#/components/schemas/Page" } + }, + "required": [ + "result", + "page" ] }, - "OperatorAllowlistStatusRequested": { + "GetCollectionResult": { "type": "object", - "description": "The request details", + "description": "Single Collection", "properties": { - "purpose": { - "description": "Reason this contract needs to be added", - "type": "string", - "example": "Custom crafting contract" - }, - "is_settlement_contract": { - "description": "Attestation of whether this contract is a settlement contract", - "type": "boolean", - "example": false + "result": { + "$ref": "#/components/schemas/Collection" } }, "required": [ - "purpose", - "is_settlement_contract" + "result" ] }, - "OperatorAllowlistStatusUpdated": { + "GetMetadataResult": { "type": "object", - "description": "The update details", + "description": "Single metadata", "properties": { - "reason": { - "description": "Why this action was performed", - "type": "string", - "example": "Contract meets expectations" + "result": { + "$ref": "#/components/schemas/Metadata" } }, "required": [ - "reason" + "result" ] }, - "OperatorAllowlistContractStatusInternal": { - "allOf": [ - { - "$ref": "#/components/schemas/OperatorAllowlistContractStatus" + "ListMetadataResult": { + "type": "object", + "properties": { + "result": { + "description": "List of metadata", + "type": "array", + "items": { + "$ref": "#/components/schemas/Metadata" + } }, - { - "type": "object", - "properties": { - "org_name": { - "description": "The name of the organisation associated with this contract", - "nullable": true, - "type": "string", - "example": "Immutable" - }, - "org_tier": { - "$ref": "#/components/schemas/OrganisationTier" - } - }, - "required": [ - "org_name", - "org_tier" - ] + "page": { + "$ref": "#/components/schemas/Page" } + }, + "required": [ + "result", + "page" ] }, - "OperatorAllowlistContractStatus": { + "Metadata": { "type": "object", "properties": { + "id": { + "$ref": "#/components/schemas/MetadataID" + }, "chain": { "$ref": "#/components/schemas/Chain" }, "contract_address": { "type": "string", - "description": "The address of the contract", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - "status": { - "$ref": "#/components/schemas/OperatorAllowlistStatus" - }, - "details": { - "$ref": "#/components/schemas/OperatorAllowlistStatusDetails" + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e", + "description": "The contract address of the metadata" }, "created_at": { "type": "string", "format": "date-time", "example": "2022-08-16T17:43:26.991388Z", - "description": "When the contract status was created" + "description": "When the metadata was created" }, - "created_by": { + "updated_at": { "type": "string", - "format": "email", - "description": "Who created the status", - "example": "user@immutable.com" - } - }, - "required": [ - "chain", - "contract_address", - "status", - "details", - "created_at", - "created_by" - ] - }, - "Call": { - "type": "object", - "properties": { - "target_address": { - "$ref": "#/components/schemas/Address" + "format": "date-time", + "nullable": true, + "description": "When the metadata was last updated", + "example": "2022-08-16T17:43:26.991388Z" }, - "function_signature": { + "name": { "type": "string", - "description": "The function signature", - "example": "mint(address,uint256)" + "nullable": true, + "example": "Sword", + "description": "The name of the NFT" }, - "function_args": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The function arguments", - "example": [ - "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e", - "1" - ] - } - }, - "required": [ - "target_address", - "function_signature", - "function_args" - ] - }, - "SignCraftingRequest": { - "type": "object", - "properties": { - "multi_caller": { - "type": "object", - "properties": { - "address": { - "$ref": "#/components/schemas/Address" - }, - "name": { - "type": "string", - "description": "The name of the multicaller contract", - "example": "Multicaller" - }, - "version": { - "type": "string", - "description": "The version of the multicaller contract", - "example": "1" - } - }, - "required": [ - "address", - "name", - "version" - ] + "description": { + "type": "string", + "nullable": true, + "example": "2022-08-16T17:43:26.991388Z", + "description": "The description of the NFT" }, - "reference_id": { + "image": { "type": "string", - "description": "The id of this request in the system that originates the crafting request, specified as a 32 byte hex string", - "example": "67f7d464b8f04f6a9a3b8d3cb4a21af0" + "nullable": true, + "description": "The image url of the NFT", + "example": "https://some-url" }, - "calls": { - "type": "array", - "description": "The calls to be signed", - "items": { - "$ref": "#/components/schemas/Call" - }, - "minLength": 1, - "maxLength": 100 + "external_url": { + "type": "string", + "nullable": true, + "description": "The external website link of NFT", + "example": "https://some-url" }, - "expires_at": { + "animation_url": { "type": "string", - "format": "date-time", - "description": "The expiration time of the request", - "example": "2022-08-16T17:43:26.991388Z" + "nullable": true, + "description": "The animation url of the NFT", + "example": "https://some-url" + }, + "youtube_url": { + "type": "string", + "nullable": true, + "description": "The youtube URL of NFT", + "example": "https://some-url" + }, + "attributes": { + "type": "array", + "description": "List of Metadata attributes", + "nullable": true, + "items": { + "$ref": "#/components/schemas/NFTMetadataAttribute" + } } }, "required": [ - "multi_caller", - "reference_id", - "calls", - "expires_at" + "id", + "chain", + "contract_address", + "created_at", + "updated_at", + "name", + "description", + "image", + "external_link", + "animation_url", + "youtube_url", + "attributes" ] }, - "SignCraftingResult": { + "RefreshMetadataByIDRequest": { "type": "object", + "description": "Request body for refreshing metadata by id. Total size of this list should not exceed 228 KiB", "properties": { - "signer_address": { - "$ref": "#/components/schemas/Address" - }, - "signature": { - "type": "string", - "description": "The signature of the request", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" + "metadata": { + "type": "array", + "maxItems": 10, + "minItems": 1, + "items": { + "$ref": "#/components/schemas/RefreshMetadataByID" + } } }, "required": [ - "signer_address", - "signature" + "metadata" ] }, - "BasicAPIError": { + "NFT": { "type": "object", "properties": { - "message": { + "chain": { + "$ref": "#/components/schemas/Chain" + }, + "token_id": { "type": "string", - "description": "Error Message", - "example": "all fields must be provided" + "example": "1", + "description": "An `uint256` token id as string" }, - "link": { + "contract_address": { "type": "string", - "description": "Link to IMX documentation that can help resolve this error", - "example": "https://docs.immutable.com/zkevm/api/reference/" + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e", + "description": "The contract address of the NFT" }, - "trace_id": { + "contract_type": { + "$ref": "#/components/schemas/NFTContractType" + }, + "indexed_at": { "type": "string", - "description": "Trace ID of the initial request", - "example": "e47634b79a5cd6894ddc9639ec4aad26" - } - }, - "required": [ - "message", - "link", - "trace_id" - ] - }, - "APIError400": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the NFT was first indexed" }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "VALIDATION_ERROR" - ], - "example": "VALIDATION_ERROR" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" - } - }, - "required": [ - "code", - "details" - ] - } - ] - }, - "APIError404": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the NFT owner was last updated" }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "RESOURCE_NOT_FOUND" - ], - "example": "RESOURCE_NOT_FOUND" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" - } - }, - "required": [ - "code", - "details" - ] - } - ] - }, - "APIError500": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" + "metadata_synced_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "When NFT metadata was last synced", + "example": "2022-08-16T17:43:26.991388Z" }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "INTERNAL_SERVER_ERROR" - ], - "example": "INTERNAL_SERVER_ERROR" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" - } - }, - "required": [ - "code", - "details" - ] - } - ] - }, - "APIError401": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" + "metadata_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "The id of the metadata of this NFT", + "example": "ae83bc80-4dd5-11ee-be56-0242ac120002" }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "UNAUTHORISED_REQUEST" - ], - "example": "UNAUTHORISED_REQUEST" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" - } - }, - "required": [ - "code", - "details" - ] - } - ] - }, - "APIError403": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" + "name": { + "type": "string", + "nullable": true, + "example": "Sword", + "description": "The name of the NFT" }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "AUTHENTICATION_ERROR" - ], - "example": "AUTHENTICATION_ERROR" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" - } - }, - "required": [ - "code", - "details" - ] - } - ] - }, - "APIError429": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" + "description": { + "type": "string", + "nullable": true, + "example": "2022-08-16T17:43:26.991388Z", + "description": "The description of the NFT" }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "TOO_MANY_REQUESTS_ERROR" - ], - "example": "TOO_MANY_REQUESTS_ERROR" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" - } - }, - "required": [ - "code", - "details" - ] - } - ] - }, - "APIError409": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" + "image": { + "type": "string", + "nullable": true, + "description": "The image url of the NFT", + "example": "https://some-url" + }, + "external_link": { + "deprecated": true, + "type": "string", + "nullable": true, + "description": "(deprecated - use external_url instead) The external website link of NFT", + "example": "https://some-url" + }, + "external_url": { + "type": "string", + "nullable": true, + "description": "The external website link of NFT", + "example": "https://some-url" + }, + "animation_url": { + "type": "string", + "nullable": true, + "description": "The animation url of the NFT", + "example": "https://some-url" }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "CONFLICT_ERROR" - ], - "example": "CONFLICT_ERROR" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error", - "additionalProperties": true - } - }, - "required": [ - "code", - "details" - ] + "youtube_url": { + "type": "string", + "nullable": true, + "description": "The youtube URL of NFT", + "example": "https://some-url" + }, + "attributes": { + "type": "array", + "description": "List of NFT Metadata attributes", + "items": { + "$ref": "#/components/schemas/NFTMetadataAttribute" + } + }, + "total_supply": { + "type": "string", + "nullable": true, + "description": "The total supply of NFT", + "example": "100" } + }, + "required": [ + "chain", + "token_id", + "contract_address", + "indexed_at", + "updated_at", + "metadata_synced_at", + "name", + "description", + "image", + "external_link", + "external_url", + "animation_url", + "youtube_url", + "attributes", + "contract_type" ] }, - "Item": { - "oneOf": [ - { - "$ref": "#/components/schemas/NativeItem" + "NFTWithBalance": { + "type": "object", + "properties": { + "chain": { + "$ref": "#/components/schemas/Chain" }, - { - "$ref": "#/components/schemas/ERC20Item" + "token_id": { + "type": "string", + "example": "1", + "description": "An `uint256` token id as string" }, - { - "$ref": "#/components/schemas/ERC721Item" + "contract_address": { + "type": "string", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e", + "description": "The contract address of the NFT" }, - { - "$ref": "#/components/schemas/ERC1155Item" + "contract_type": { + "$ref": "#/components/schemas/NFTContractType" }, - { - "$ref": "#/components/schemas/ERC721CollectionItem" + "indexed_at": { + "type": "string", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the NFT was first indexed" }, - { - "$ref": "#/components/schemas/ERC1155CollectionItem" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "NATIVE": "#/components/schemas/NativeItem", - "ERC20": "#/components/schemas/ERC20Item", - "ERC721": "#/components/schemas/ERC721Item", - "ERC1155": "#/components/schemas/ERC1155Item", - "ERC721_COLLECTION": "#/components/schemas/ERC721CollectionItem", - "ERC1155_COLLECTION": "#/components/schemas/ERC1155CollectionItem" - } - } - }, - "AssetCollectionItem": { - "oneOf": [ - { - "$ref": "#/components/schemas/ERC721CollectionItem" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the NFT owner was last updated" }, - { - "$ref": "#/components/schemas/ERC1155CollectionItem" - } - ], - "discriminator": { - "propertyName": "type", - "mapping": { - "ERC721_COLLECTION": "#/components/schemas/ERC721CollectionItem", - "ERC1155_COLLECTION": "#/components/schemas/ERC1155CollectionItem" + "metadata_synced_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "When NFT metadata was last synced", + "example": "2022-08-16T17:43:26.991388Z" + }, + "metadata_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "The id of the metadata of this NFT", + "example": "ae83bc80-4dd5-11ee-be56-0242ac120002" + }, + "name": { + "type": "string", + "nullable": true, + "description": "The name of the NFT", + "example": "Sword" + }, + "description": { + "type": "string", + "nullable": true, + "description": "The description of the NFT", + "example": "This is a super awesome sword" + }, + "image": { + "type": "string", + "nullable": true, + "description": "The image url of the NFT", + "example": "https://some-url" + }, + "external_link": { + "type": "string", + "nullable": true, + "description": "The external website link of NFT", + "example": "https://some-url" + }, + "animation_url": { + "type": "string", + "nullable": true, + "description": "The animation url of the NFT", + "example": "https://some-url" + }, + "youtube_url": { + "type": "string", + "nullable": true, + "description": "The youtube URL of NFT", + "example": "https://some-url" + }, + "attributes": { + "type": "array", + "description": "List of Metadata attributes", + "nullable": false, + "items": { + "$ref": "#/components/schemas/NFTMetadataAttribute" + } + }, + "balance": { + "type": "string", + "nullable": false, + "description": "The amount of this NFT this account owns", + "example": "11" } - } + }, + "required": [ + "chain", + "token_id", + "contract_address", + "indexed_at", + "updated_at", + "metadata_synced_at", + "name", + "description", + "image", + "external_link", + "animation_url", + "youtube_url", + "balance", + "contract_type", + "attributes" + ] }, - "FulfillmentDataRequest": { + "NFTMetadataAttribute": { "type": "object", "properties": { - "order_id": { + "display_type": { + "description": "Display type for this attribute", "type": "string", - "format": "uuid" + "nullable": true, + "enum": [ + "number", + "boost_percentage", + "boost_number", + "date" + ], + "example": "number" }, - "taker_address": { + "trait_type": { + "description": "The metadata trait type", "type": "string", - "description": "Address of the intended account fulfilling the order", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "pattern": "^0x[a-fA-F0-9]{40}$" + "example": "Aqua Power" }, - "fees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Fee" - }, - "example": [ + "value": { + "oneOf": [ { - "type": "TAKER_ECOSYSTEM", - "amount": "2250000000000000000", - "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233" + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" } ], - "minItems": 0, - "maxItems": 2 - }, - "token_id": { - "type": "string", - "description": "Token ID for the ERC721 or ERC1155 token when fulfilling a collection order", - "example": "123", - "pattern": "\\d+" + "description": "The metadata trait value", + "example": "Happy" } }, "required": [ - "order_id", - "fees", - "taker_address" + "trait_type", + "value" ] }, - "FulfillableOrder": { + "ChainName": { + "type": "string", + "description": "The name of chain", + "example": "imtbl-zkevm-testnet" + }, + "ActivityID": { + "description": "Activity id in UUIDv4 format", + "type": "string", + "format": "uuid", + "example": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b" + }, + "MetadataID": { + "description": "Metadata id in UUIDv4 format", + "type": "string", + "format": "uuid", + "example": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b" + }, + "CollectionContractType": { + "description": "The collection contract type", + "type": "string", + "enum": [ + "ERC721", + "ERC1155" + ] + }, + "NFTContractType": { + "description": "The contract type for an NFT", + "type": "string", + "enum": [ + "ERC721", + "ERC1155" + ] + }, + "TokenContractType": { + "description": "The contract type for a token", + "type": "string", + "enum": [ + "ERC20" + ] + }, + "AssetVerificationStatus": { + "description": "The verification status for a given contract", + "type": "string", + "enum": [ + "verified", + "unverified", + "spam", + "inactive" + ] + }, + "VerificationRequestStatus": { + "description": "The status of the verification request", + "type": "string", + "enum": [ + "completed", + "pending" + ] + }, + "GetNFTResult": { "type": "object", + "description": "Single NFT", "properties": { - "order": { - "$ref": "#/components/schemas/Order" - }, - "token_id": { - "type": "string", - "description": "Token ID for the ERC721 or ERC1155 token when fulfilling a collection order", - "example": "123", - "pattern": "\\d+" - }, - "extra_data": { - "type": "string" + "result": { + "$ref": "#/components/schemas/NFT" } }, "required": [ - "extra_data", - "order" + "result" ] }, - "UnfulfillableOrder": { + "ListNFTsResult": { "type": "object", "properties": { - "order_id": { - "type": "string", - "description": "OrderID for the requested but unfulfillable order", - "example": "7df3e99e-f7b3-459c-bef6-ffb66a18bb59" - }, - "token_id": { - "type": "string", - "description": "Token ID for the ERC721 or ERC1155 token when fulfilling a collection order", - "example": "123", - "pattern": "\\d+" + "result": { + "description": "List of NFTs", + "type": "array", + "items": { + "$ref": "#/components/schemas/NFT" + } }, - "reason": { - "type": "string", - "description": "Nullable string containing error reason if the signing is unsuccessful for the order", - "example": "Invalid order status INACTIVE for order 7df3e99e-f7b3-459c-bef6-ffb66a18bb59" + "page": { + "$ref": "#/components/schemas/Page" } }, "required": [ - "reason", - "order_id" + "result", + "page" ] }, - "NativeItem": { + "ListNFTsByOwnerResult": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Token type user is offering, which in this case is the native IMX token", - "example": "NATIVE", - "enum": [ - "NATIVE" - ] + "result": { + "description": "List of NFTs by owner", + "type": "array", + "items": { + "$ref": "#/components/schemas/NFTWithBalance" + } }, - "amount": { - "type": "string", - "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", - "example": "9750000000000000000", - "pattern": "\\d+" + "page": { + "$ref": "#/components/schemas/Page" } }, "required": [ - "type", - "amount" + "result", + "page" ] }, - "ERC20Item": { + "NFTOwner": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Token type user is offering, which in this case is ERC20", - "example": "ERC20", - "enum": [ - "ERC20" - ] + "chain": { + "$ref": "#/components/schemas/Chain" }, "contract_address": { "type": "string", - "description": "Address of ERC20 token", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F", - "pattern": "^0x[a-fA-F0-9]{40}$" + "description": "The address of NFT contract", + "example": "0x5a019874f4fae314b0eaa4606be746366e661306" }, - "amount": { + "token_id": { "type": "string", - "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", - "example": "9750000000000000000", - "pattern": "\\d+" + "description": "An `uint256` token id as string", + "example": "1" + }, + "account_address": { + "type": "string", + "description": "The account address of the owner of the NFT", + "example": "0x5a019874f4fae314b0eaa4606be746366e661306" + }, + "balance": { + "type": "string", + "description": "The amount of owned tokens (uint256 as string)", + "example": "1" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the NFT owner was last updated" } }, "required": [ - "type", + "chain", "contract_address", - "amount" + "token_id", + "account_address", + "balance" ] }, - "ERC721Item": { + "NFTWithOwner": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Token type user is offering, which in this case is ERC721", - "example": "ERC721", - "enum": [ - "ERC721" - ] + "chain": { + "$ref": "#/components/schemas/Chain" }, "contract_address": { "type": "string", - "description": "Address of ERC721 token", - "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "pattern": "^0x[a-fA-F0-9]{40}$" + "description": "The address of NFT contract", + "example": "0x5a019874f4fae314b0eaa4606be746366e661306" }, "token_id": { "type": "string", - "description": "ID of ERC721 token", - "example": "1", - "pattern": "\\d+" + "description": "An `uint256` token id as string", + "example": "1" + }, + "account_address": { + "type": "string", + "description": "The account address of the owner of the NFT", + "example": "0x5a019874f4fae314b0eaa4606be746366e661306" + }, + "balance": { + "type": "string", + "description": "The amount of owned tokens (uint256 as string)", + "example": "1" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the owner last changed for the given NFT" } }, "required": [ - "type", + "chain", "contract_address", - "token_id" + "token_id", + "account_address", + "balance", + "updated_at" ] }, - "ERC1155Item": { + "GetTokenResult": { "type": "object", + "description": "Single Token", "properties": { - "type": { - "type": "string", - "description": "Token type user is offering, which in this case is ERC1155", - "example": "ERC1155", - "enum": [ - "ERC1155" - ] - }, - "contract_address": { - "type": "string", - "description": "Address of ERC1155 token", - "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, - "token_id": { - "type": "string", - "description": "ID of ERC1155 token", - "example": "1", - "pattern": "\\d+" + "result": { + "$ref": "#/components/schemas/Token" + } + }, + "required": [ + "result" + ] + }, + "ListNFTOwnersResult": { + "type": "object", + "properties": { + "result": { + "description": "List of nft owners", + "type": "array", + "items": { + "$ref": "#/components/schemas/NFTOwner" + } }, - "amount": { - "type": "string", - "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", - "example": "9750000000000000000", - "pattern": "\\d+" + "page": { + "$ref": "#/components/schemas/Page" } }, "required": [ - "type", - "contract_address", - "token_id", - "amount" + "result", + "page" ] }, - "ERC721CollectionItem": { + "ListCollectionOwnersResult": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Token type user is offering, which in this case is ERC721", - "example": "ERC721_COLLECTION", - "enum": [ - "ERC721_COLLECTION" - ] - }, - "contract_address": { - "type": "string", - "description": "Address of ERC721 collection", - "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "pattern": "^0x[a-fA-F0-9]{40}$" + "result": { + "description": "List of NFT owners", + "type": "array", + "items": { + "$ref": "#/components/schemas/NFTWithOwner" + } }, - "amount": { - "type": "string", - "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", - "example": "9750000000000000000", - "pattern": "\\d+" + "page": { + "$ref": "#/components/schemas/Page" } }, "required": [ - "type", - "contract_address", - "amount" + "result", + "page" ] }, - "ERC1155CollectionItem": { + "ChainWithDetails": { + "allOf": [ + { + "$ref": "#/components/schemas/Chain" + }, + { + "type": "object", + "properties": { + "rpc_url": { + "type": "string", + "nullable": true, + "description": "URL for RPC node" + }, + "operator_allowlist_address": { + "type": "string", + "nullable": true, + "description": "The address of the Operator Allowlist - https://docs.immutable.com/products/zkevm/minting/royalties/allowlist-spec/" + }, + "minter_address": { + "type": "string", + "nullable": true, + "description": "The address of the minter used in the Minting API - https://docs.immutable.com/products/zkEVM/minting/minting-api#minting-api-prerequisites" + } + }, + "required": [ + "rpc_url", + "operator_allowlist_address", + "minter_address" + ] + } + ] + }, + "Chain": { "type": "object", + "description": "The chain details", "properties": { - "type": { - "type": "string", - "description": "Token type user is offering, which in this case is ERC1155", - "example": "ERC1155_COLLECTION", - "enum": [ - "ERC1155_COLLECTION" - ] - }, - "contract_address": { + "id": { "type": "string", - "description": "Address of ERC1155 collection", - "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "pattern": "^0x[a-fA-F0-9]{40}$" + "description": "The id of chain", + "example": "eip155:13372" }, - "amount": { + "name": { "type": "string", - "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", - "example": "9750000000000000000", - "pattern": "\\d+" + "description": "The name of chain", + "example": "imtbl-zkevm-testnet" } }, "required": [ - "type", - "contract_address", - "amount" + "id", + "name" ] }, - "CancelOrdersRequestBody": { + "ListChainsResult": { "type": "object", "properties": { - "account_address": { - "type": "string", - "description": "Address of the user initiating the cancel request", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, - "orders": { + "result": { "type": "array", - "description": "List of order ids proposed for cancellation", + "description": "List of chains", "items": { - "type": "string", - "format": "uuid" - }, - "uniqueItems": true, - "minItems": 1, - "maxItems": 20 + "$ref": "#/components/schemas/ChainWithDetails" + } }, - "signature": { - "type": "string", - "description": "Signature generated by the user for the specific cancellation request", - "example": "0x12345" + "page": { + "$ref": "#/components/schemas/Page" } }, "required": [ - "account_address", - "orders", - "signature" - ], - "example": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "ids": [ - "018a8c71-d7e4-e303-a2ef-318871ef7756", - "238a8c71-d7e4-e303-a2ef-318871ef7778", - "458a8c71-d7e4-e303-a2ef-318871ef7790" - ], - "signature": 291 - } + "result", + "page" + ] }, - "CreateListingRequestBody": { + "ListTokensResult": { "type": "object", "properties": { - "account_address": { - "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, - "order_hash": { - "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" - }, - "buy": { + "result": { "type": "array", - "description": "Buy item for listing should either be NATIVE or ERC20 item", + "description": "List of tokens", "items": { - "$ref": "#/components/schemas/Item" - }, - "example": [ - { - "type": "NATIVE", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - } - ], - "minItems": 1, - "maxItems": 1 + "$ref": "#/components/schemas/Token" + } }, - "fees": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/components/schemas/Fee" + "page": { + "$ref": "#/components/schemas/Page" + } + }, + "required": [ + "result", + "page" + ] + }, + "RefreshMetadataByID": { + "allOf": [ + { + "$ref": "#/components/schemas/RefreshableNFTAttributes" + }, + { + "type": "object", + "properties": { + "metadata_id": { + "$ref": "#/components/schemas/MetadataID" + } }, - "example": [], - "minItems": 0, - "maxItems": 2 + "required": [ + "metadata_id" + ] + } + ] + }, + "RefreshMetadataByTokenID": { + "allOf": [ + { + "$ref": "#/components/schemas/RefreshableNFTAttributes" }, - "end_at": { + { + "type": "object", + "properties": { + "token_id": { + "type": "string", + "description": "An `uint256` token id as string", + "example": "1" + } + }, + "required": [ + "token_id" + ] + } + ] + }, + "RefreshableNFTAttributes": { + "allOf": [ + { + "$ref": "#/components/schemas/NFTMetadataRequest" + } + ], + "required": [ + "name", + "description", + "image", + "external_url", + "animation_url", + "youtube_url", + "attributes" + ] + }, + "NFTMetadataRequest": { + "type": "object", + "description": "The NFT metadata. Total size of this object should not exceed 16 KiB", + "properties": { + "name": { "type": "string", - "description": "Time after which the Order is considered expired", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" + "nullable": true, + "example": "Sword", + "description": "The name of the NFT" }, - "protocol_data": { - "$ref": "#/components/schemas/ProtocolData" + "description": { + "type": "string", + "nullable": true, + "example": "2022-08-16T17:43:26.991388Z", + "description": "The description of the NFT" }, - "salt": { + "image": { "type": "string", - "description": "A random value added to the create Order request", - "example": "12686911856931635052326433555881236148" + "nullable": true, + "description": "The image url of the NFT", + "example": "https://some-url" }, - "sell": { - "type": "array", - "description": "Sell item for listing should be an ERC721 item", - "items": { - "$ref": "#/components/schemas/Item" - }, - "example": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "minItems": 1, - "maxItems": 1 + "external_url": { + "type": "string", + "nullable": true, + "description": "The external link of the NFT", + "example": "https://some-url" }, - "signature": { + "animation_url": { "type": "string", - "description": "Digital signature generated by the user for the specific Order", - "example": "0x" + "nullable": true, + "description": "The animation url of the NFT", + "example": "https://some-url" }, - "start_at": { + "youtube_url": { "type": "string", - "description": "Time after which Order is considered active", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" - } - }, - "example": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770", - "buy": [ - { - "type": "NATIVE", - "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.4" + "nullable": true, + "description": "The youtube link of the NFT", + "example": "https://some-url" }, - "salt": "12686911856931635052326433555881236148", - "sell": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" + "attributes": { + "type": "array", + "description": "List of Metadata attributes", + "nullable": true, + "items": { + "$ref": "#/components/schemas/NFTMetadataAttribute" } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z" + } + } + }, + "RefreshNFTMetadataByTokenIDRequest": { + "type": "object", + "properties": { + "nft_metadata": { + "type": "array", + "description": "List of nft metadata to be refreshed. Total size of the list should not exceed 228 KiB", + "maxItems": 250, + "minItems": 1, + "items": { + "$ref": "#/components/schemas/RefreshMetadataByTokenID" + } + } }, "required": [ - "account_address", - "order_hash", - "buy", - "sell", - "fees", - "end_at", - "start_at", - "protocol_data", - "salt", - "signature" + "nft_metadata" ] }, - "CreateBidRequestBody": { + "Token": { "type": "object", "properties": { - "account_address": { - "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "pattern": "^0x[a-fA-F0-9]{40}$" + "chain": { + "$ref": "#/components/schemas/Chain" }, - "order_hash": { + "contract_address": { "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" - }, - "buy": { - "type": "array", - "description": "Buy item for bid should either be ERC721 or ERC1155 item", - "items": { - "$ref": "#/components/schemas/Item" - }, - "example": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "minItems": 1, - "maxItems": 1 + "description": "The address of token contract", + "example": "0xc344c05eef8876e517072f879dae8905aa2b956b" }, - "fees": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/components/schemas/Fee" - }, - "example": [], - "minItems": 0, - "maxItems": 2 + "root_contract_address": { + "type": "string", + "description": "The address of root token contract", + "example": "0x43e60b30d5bec48c0f5890e3d1e9f1b1296bb4aa", + "nullable": true }, - "end_at": { + "root_chain_id": { "type": "string", - "description": "Time after which the Order is considered expired", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" + "description": "The id of the root chain for a bridged token", + "example": "eip155:1", + "nullable": true }, - "protocol_data": { - "$ref": "#/components/schemas/ProtocolData" + "bridge_used": { + "type": "string", + "description": "The name of the bridge, for bridged tokens only", + "example": "axelar", + "nullable": true }, - "salt": { + "symbol": { "type": "string", - "description": "A random value added to the create Order request", - "example": "12686911856931635052326433555881236148" + "description": "The symbol of token", + "example": "AAA", + "nullable": true }, - "sell": { - "type": "array", - "description": "Sell item for bid should be an ERC20 item", - "items": { - "$ref": "#/components/schemas/ERC20Item" - }, - "example": [ - { - "type": "ERC20", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "amount": "9750000000000000000" - } - ], - "minItems": 1, - "maxItems": 1 + "decimals": { + "type": "integer", + "description": "The decimals of token", + "example": 18, + "nullable": true }, - "signature": { + "image_url": { "type": "string", - "description": "Digital signature generated by the user for the specific Order", - "example": "0x" + "description": "The image url of token", + "example": "https://some-url", + "nullable": true }, - "start_at": { + "name": { "type": "string", - "description": "Time after which Order is considered active", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" - } - }, - "example": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770", - "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" + "description": "The name of token", + "example": "Token A", + "nullable": true + }, + "verification_status": { + "$ref": "#/components/schemas/AssetVerificationStatus" }, - "salt": "12686911856931635052326433555881236148", - "buy": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the collection was last updated" + }, + "is_canonical": { + "type": "boolean", + "example": true, + "description": "Indicates whether the token is canonical or not" + } }, "required": [ - "account_address", - "order_hash", - "buy", - "sell", - "fees", - "end_at", - "start_at", - "protocol_data", - "salt", - "signature" + "chain", + "contract_address", + "root_contract_address", + "symbol", + "decimals", + "image_url", + "name", + "updated_at", + "verification_status", + "is_canonical" ] }, - "CreateCollectionBidRequestBody": { + "CollectionMetadata": { "type": "object", "properties": { - "account_address": { + "name": { "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "pattern": "^0x[a-fA-F0-9]{40}$" + "nullable": true, + "description": "The name of the collection", + "example": "Gigantic Lizards" }, - "order_hash": { + "symbol": { "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" - }, - "buy": { - "type": "array", - "description": "Buy item for collection bid should either be ERC721 or ERC1155 collection item", - "items": { - "$ref": "#/components/schemas/AssetCollectionItem" - }, - "example": [ - { - "type": "ERC721_COLLECTION", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "amount": "1" - } - ], - "minItems": 1, - "maxItems": 1 - }, - "fees": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/components/schemas/Fee" - }, - "example": [], - "minItems": 0, - "maxItems": 2 + "nullable": true, + "description": "The symbol of contract", + "example": "GLZ" }, - "end_at": { + "description": { "type": "string", - "description": "Time after which the Order is considered expired", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" - }, - "protocol_data": { - "$ref": "#/components/schemas/ProtocolData" + "nullable": true, + "description": "The description of collection", + "example": "This is the Gigantic Lizards collection" }, - "salt": { + "image": { "type": "string", - "description": "A random value added to the create Order request", - "example": "12686911856931635052326433555881236148" + "description": "The url of the collection image", + "example": "https://some-url", + "nullable": true }, - "sell": { - "type": "array", - "description": "Sell item for collection bid should be an ERC20 item", - "items": { - "$ref": "#/components/schemas/ERC20Item" - }, - "example": [ - { - "type": "ERC20", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "amount": "9750000000000000000" - } - ], - "minItems": 1, - "maxItems": 1 + "external_link": { + "type": "string", + "description": "The url of external link", + "example": "https://some-url", + "nullable": true }, - "signature": { + "contract_uri": { "type": "string", - "description": "Digital signature generated by the user for the specific Order", - "example": "0x" + "description": "The uri for the metadata of the collection", + "example": "https://some-url", + "nullable": true }, - "start_at": { + "base_uri": { "type": "string", - "description": "Time after which Order is considered active", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" + "nullable": true, + "description": "The metadata uri for nft", + "example": "https://some-url" } }, - "example": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770", - "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" + "required": [ + "name", + "image", + "symbol", + "description", + "base_uri", + "external_link", + "contract_uri" + ] + }, + "RefreshCollectionMetadataRequest": { + "type": "object", + "properties": { + "collection_metadata": { + "$ref": "#/components/schemas/CollectionMetadata" + } + }, + "required": [ + "collection_metadata" + ] + }, + "RefreshCollectionMetadataResult": { + "type": "object", + "properties": { + "contract_address": { + "type": "string" }, - "salt": "12686911856931635052326433555881236148", - "buy": [ - { - "type": "ERC721_COLLECTION", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "amount": "1" + "chain": { + "$ref": "#/components/schemas/Chain" + }, + "collection_metadata": { + "$ref": "#/components/schemas/CollectionMetadata" + } + }, + "required": [ + "contract_address", + "chain", + "collection_metadata" + ] + }, + "MetadataRefreshRateLimitResult": { + "type": "object", + "properties": { + "imx_refreshes_limit": { + "type": "string" + }, + "imx_refresh_limit_reset": { + "type": "string" + }, + "imx_remaining_refreshes": { + "type": "string" + }, + "retry_after": { + "type": "string" + } + }, + "required": [ + "imx_refreshes_limit", + "imx_refresh_limit_reset", + "imx_remaining_refreshes", + "retry_after" + ] + }, + "CreateMintRequestRequest": { + "type": "object", + "properties": { + "assets": { + "type": "array", + "maxItems": 100, + "minItems": 1, + "description": "List of nft to be minted", + "items": { + "$ref": "#/components/schemas/MintAsset" } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z" + } }, "required": [ - "account_address", - "order_hash", - "buy", - "sell", - "fees", - "end_at", - "start_at", - "protocol_data", - "salt", - "signature" + "assets" + ] + }, + "VerificationRequestInternal": { + "description": "The verification request (internal)", + "allOf": [ + { + "$ref": "#/components/schemas/VerificationRequest" + }, + { + "type": "object", + "properties": { + "org_tier": { + "$ref": "#/components/schemas/OrganisationTier" + } + }, + "required": [ + "org_tier" + ] + } ] }, - "Fee": { + "VerificationRequest": { + "description": "The verification request", "type": "object", "properties": { - "amount": { + "id": { + "description": "The id of the verification request", "type": "string", - "description": "Fee payable to recipient upon settlement", - "example": "2250000000000000000", - "pattern": "\\d+" + "format": "uuid", + "example": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b" }, - "type": { + "chain": { + "$ref": "#/components/schemas/Chain" + }, + "contract_address": { + "description": "The contract address", "type": "string", - "description": "Fee type", - "example": "ROYALTY", - "enum": [ - "ROYALTY", - "MAKER_ECOSYSTEM", - "TAKER_ECOSYSTEM", - "PROTOCOL" - ] + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "recipient_address": { + "org_name": { + "description": "The name of the organisation associated with this contract", + "nullable": true, "type": "string", - "description": "Wallet address of fee recipient", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233", - "pattern": "^0x[a-fA-F0-9]{40}$" + "example": "Immutable" + }, + "name": { + "type": "string", + "nullable": true, + "description": "The name of the collection", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" + }, + "symbol": { + "type": "string", + "nullable": true, + "description": "The symbol of contract", + "example": "BASP" + }, + "description": { + "type": "string", + "nullable": true, + "description": "The description of collection", + "example": "Some description" + }, + "org_id": { + "type": "string", + "nullable": true, + "description": "The id of the organisation associated with this contract", + "example": "753da67a-5d3b-42c7-b87a-eba3d17a6362" + }, + "requester_email": { + "type": "string", + "nullable": true, + "description": "The email address of the user who requested the contract to be verified", + "example": "user@immutable.com" + }, + "contract_type": { + "$ref": "#/components/schemas/VerificationRequestContractType" + }, + "verification_request_status": { + "$ref": "#/components/schemas/VerificationRequestStatus" } }, - "example": { - "amount": "2250000000000000000", - "type": "ROYALTY", - "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233" - }, "required": [ - "type", - "amount", - "recipient_address" + "id", + "chain", + "contract_address", + "name", + "symbol", + "description", + "contract_type", + "org_name", + "org_id", + "requester_email", + "verification_request_status" ] }, - "Order": { + "VerificationRequestContractType": { + "description": "The contract type associated with the given request", + "type": "string", + "enum": [ + "ERC20", + "ERC721", + "ERC1155" + ] + }, + "OrganisationTier": { + "description": "The tier of the organisation", + "type": "string", + "nullable": true, + "enum": [ + "common", + "uncommon", + "rare", + "epic", + "legendary" + ] + }, + "MintAsset": { "type": "object", "properties": { - "account_address": { + "reference_id": { "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" - }, - "buy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Item" - }, - "example": [ - { - "type": "NATIVE", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - } - ], - "minItems": 1, - "maxItems": 1 - }, - "fees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Fee" - }, - "example": [], - "minItems": 0 - }, - "chain": { - "$ref": "#/components/schemas/Chain" + "description": "The id of this asset in the system that originates the mint request", + "example": "67f7d464-b8f0-4f6a-9a3b-8d3cb4a21af0" }, - "created_at": { + "owner_address": { "type": "string", - "description": "Time the Order is created", - "format": "date-time", - "example": "2022-03-07T07:20:50.52Z" + "description": "The address of the receiver", + "example": "0xc344c05eef8876e517072f879dae8905aa2b956b" }, - "end_at": { + "token_id": { "type": "string", - "description": "Time after which the Order is considered expired", - "format": "date-time", - "example": "2022-03-10T05:00:50.52Z" + "description": "An optional `uint256` token id as string. Required for ERC1155 collections.", + "example": "1", + "nullable": true }, - "id": { + "amount": { "type": "string", - "description": "Global Order identifier", - "example": "018792C9-4AD7-8EC4-4038-9E05C598534A" + "description": "Optional mount of tokens to mint. Required for ERC1155 collections. ERC712 collections can omit this field or set it to 1", + "example": "1", + "nullable": true, + "minLength": 1 }, - "order_hash": { - "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" + "metadata": { + "$ref": "#/components/schemas/NFTMetadataRequest" + } + }, + "required": [ + "reference_id", + "owner_address" + ] + }, + "CreateMintRequestResult": { + "type": "object", + "properties": { + "imx_mint_requests_limit": { + "type": "string" }, - "protocol_data": { - "$ref": "#/components/schemas/ProtocolData" + "imx_mint_requests_limit_reset": { + "type": "string" }, - "salt": { - "type": "string", - "description": "A random value added to the create Order request", - "example": "12686911856931635052326433555881236148" + "imx_remaining_mint_requests": { + "type": "string" }, - "sell": { + "imx_mint_requests_retry_after": { + "type": "string" + } + }, + "required": [ + "imx_mint_requests_limit", + "imx_mint_requests_limit_reset", + "imx_remaining_mint_requests", + "imx_mint_requests_retry_after" + ] + }, + "ListMintRequestsResult": { + "type": "object", + "description": "List mint requests", + "properties": { + "result": { "type": "array", + "description": "List of mint requests", "items": { - "$ref": "#/components/schemas/Item" - }, - "example": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "minItems": 1, - "maxItems": 1 + "$ref": "#/components/schemas/GetMintRequestResult" + } }, - "signature": { - "type": "string", - "description": "Digital signature generated by the user for the specific Order", - "example": "0x" + "page": { + "$ref": "#/components/schemas/Page" + } + }, + "required": [ + "result", + "page" + ] + }, + "GetMintRequestResult": { + "type": "object", + "properties": { + "chain": { + "$ref": "#/components/schemas/Chain" }, - "start_at": { + "collection_address": { "type": "string", - "description": "Time after which Order is considered active", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" - }, - "status": { - "$ref": "#/components/schemas/OrderStatus" + "description": "The address of the contract", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "type": { + "reference_id": { "type": "string", - "description": "Order type", - "example": "LISTING", - "enum": [ - "LISTING", - "BID", - "COLLECTION_BID", - "TRAIT_BID", - "METADATA_BID" - ] + "description": "The reference id of this mint request" }, - "updated_at": { + "owner_address": { "type": "string", - "description": "Time the Order is last updated", - "format": "date-time", - "example": "2022-03-07T07:20:50.52Z" + "description": "The address of the owner of the NFT" }, - "fill_status": { - "$ref": "#/components/schemas/FillStatus" + "token_id": { + "type": "string", + "example": "1", + "nullable": true, + "description": "An `uint256` token id as string. Only available when the mint request succeeds" }, - "trait_criteria": { - "type": "array", - "description": "Trait filters for TRAIT_BID orders; omitted for other order types.", - "items": { - "$ref": "#/components/schemas/TraitFilter" - }, - "minItems": 1, - "example": [ - { - "trait_type": "Background", - "values": [ - "Blue", - "Red" - ] - } - ] + "amount": { + "type": "string", + "example": "1", + "nullable": true, + "description": "An `uint256` amount as string. Only relevant for mint requests on ERC1155 contracts" }, - "metadata_id": { + "activity_id": { "type": "string", "format": "uuid", - "description": "Metadata identifier for METADATA_BID orders created with a single metadata stack. Omitted for other order types and for metadata bids created with `metadata_criteria`.", - "example": "018792C9-4AD7-8EC4-4038-9E05C598534B" + "example": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b", + "nullable": true, + "description": "The id of the mint activity associated with this mint request" }, - "metadata_criteria": { - "type": "array", - "description": "Field-level metadata filters for METADATA_BID orders created with criteria instead of a `metadata_id`. Omitted for other order types and for metadata bids created with a `metadata_id`.", - "items": { - "$ref": "#/components/schemas/MetadataFieldFilter" - }, - "minItems": 1, - "example": [ - { - "field_name": "name", - "values": [ - "Cool Dragon" - ] - }, - { - "field_name": "attribute:Background", - "values": [ - "Blue", - "Red" - ] - } - ] - } - }, - "example": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "buy": [ - { - "type": "NATIVE", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - } - ], - "fees": [], - "chain": { - "id": "eip155:11155111", - "name": "sepolia" + "transaction_hash": { + "type": "string", + "nullable": true, + "description": "The transaction hash of the activity", + "example": "0x68d9eac5e3b3c3580404989a4030c948a78e1b07b2b5ea5688d8c38a6c61c93e" }, - "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" + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the mint request was created" }, - "salt": "12686911856931635052326433555881236148", - "sell": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z", - "status": { - "name": "ACTIVE" + "updated_at": { + "type": "string", + "format": "date-time", + "description": "When the mint request was last updated", + "example": "2022-08-16T17:43:26.991388Z" }, - "fill_status": { - "numerator": 1, - "denominator": 2 + "error": { + "$ref": "#/components/schemas/MintRequestErrorMessage" }, - "type": "LISTING", - "updated_at": "2022-03-07T07:20:50.52Z" + "status": { + "$ref": "#/components/schemas/MintRequestStatus" + } }, "required": [ - "id", - "type", - "account_address", - "buy", - "sell", - "fees", "chain", - "created_at", - "end_at", - "start_at", - "updated_at", - "order_hash", - "protocol_data", - "salt", - "signature", + "collection_address", + "reference_id", + "owner_address", "status", - "fill_status" + "token_id", + "transaction_hash", + "error", + "created_at", + "updated_at" + ] + }, + "MintRequestErrorMessage": { + "type": "object", + "description": "The error details in case the mint request fails", + "nullable": true, + "properties": { + "message": { + "description": "An error message in case the mint request fails", + "type": "string" + } + } + }, + "MintRequestStatus": { + "description": "The status of the mint request", + "example": "pending", + "type": "string", + "enum": [ + "pending", + "succeeded", + "failed" + ] + }, + "OperatorAllowlistStatus": { + "description": "The status of a contract on the operator allowlist", + "example": "requested", + "type": "string", + "enum": [ + "requested", + "approved", + "rejected", + "removed", + "added" + ] + }, + "OperatorAllowlistStatusDetails": { + "description": "The operator allowlist status details", + "oneOf": [ + { + "$ref": "#/components/schemas/OperatorAllowlistStatusRequested" + }, + { + "$ref": "#/components/schemas/OperatorAllowlistStatusUpdated" + } + ] + }, + "OperatorAllowlistStatusRequested": { + "type": "object", + "description": "The request details", + "properties": { + "purpose": { + "description": "Reason this contract needs to be added", + "type": "string", + "example": "Custom crafting contract" + }, + "is_settlement_contract": { + "description": "Attestation of whether this contract is a settlement contract", + "type": "boolean", + "example": false + } + }, + "required": [ + "purpose", + "is_settlement_contract" + ] + }, + "OperatorAllowlistStatusUpdated": { + "type": "object", + "description": "The update details", + "properties": { + "reason": { + "description": "Why this action was performed", + "type": "string", + "example": "Contract meets expectations" + } + }, + "required": [ + "reason" + ] + }, + "OperatorAllowlistContractStatusInternal": { + "allOf": [ + { + "$ref": "#/components/schemas/OperatorAllowlistContractStatus" + }, + { + "type": "object", + "properties": { + "org_name": { + "description": "The name of the organisation associated with this contract", + "nullable": true, + "type": "string", + "example": "Immutable" + }, + "org_tier": { + "$ref": "#/components/schemas/OrganisationTier" + } + }, + "required": [ + "org_name", + "org_tier" + ] + } ] }, - "Trade": { + "OperatorAllowlistContractStatus": { "type": "object", "properties": { - "buy": { - "description": "Buy items are transferred from the taker to the maker.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Item" - }, - "example": [ - { - "type": "NATIVE", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - } - ], - "minItems": 1, - "maxItems": 1 - }, - "buyer_address": { - "description": "Deprecated. Use maker and taker addresses instead of buyer and seller addresses.", - "type": "string", - "example": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40" - }, - "buyer_fees": { - "description": "Deprecated. Use fees instead. The taker always pays the fees.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Fee" - }, - "example": [], - "minItems": 0, - "maxItems": 1 - }, - "fees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Fee" - }, - "example": [], - "minItems": 0, - "maxItems": 1 - }, "chain": { "$ref": "#/components/schemas/Chain" }, - "order_id": { - "type": "string", - "example": "7df3e99e-f7b3-459c-bef6-ffb66a18bb59" - }, - "blockchain_metadata": { - "$ref": "#/components/schemas/TradeBlockchainMetadata" - }, - "indexed_at": { - "type": "string", - "description": "Time the on-chain trade event is indexed by the order book system", - "format": "date-time", - "example": "2022-03-07T07:20:50.52Z" - }, - "id": { + "contract_address": { "type": "string", - "description": "Global Trade identifier", - "example": "018792C9-4AD7-8EC4-4038-9E05C598534A" + "description": "The address of the contract", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "sell": { - "description": "Sell items are transferred from the maker to the taker.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Item" - }, - "example": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "minItems": 1, - "maxItems": 1 + "status": { + "$ref": "#/components/schemas/OperatorAllowlistStatus" }, - "seller_address": { - "description": "Deprecated. Use maker and taker addresses instead of buyer and seller addresses.", - "type": "string", - "example": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D" + "details": { + "$ref": "#/components/schemas/OperatorAllowlistStatusDetails" }, - "maker_address": { + "created_at": { "type": "string", - "example": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D" + "format": "date-time", + "example": "2022-08-16T17:43:26.991388Z", + "description": "When the contract status was created" }, - "taker_address": { + "created_by": { "type": "string", - "example": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40" + "format": "email", + "description": "Who created the status", + "example": "user@immutable.com" } }, - "example": { - "buy": [ - { - "type": "NATIVE", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - } - ], - "buyer_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", - "buyer_fees": [], - "fees": [], - "chain": { - "id": "eip155:11155111", - "name": "sepolia" - }, - "indexed_at": "2022-03-07T07:20:50.52Z", - "id": "018792C9-4AD7-8EC4-4038-9E05C598534A", - "sell": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "seller_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", - "maker_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", - "taker_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40" - }, "required": [ - "id", - "order_id", - "buy", - "buyer_address", - "sell", - "seller_address", - "buyer_fees", - "fees", "chain", - "maker_address", - "taker_address", - "indexed_at", - "blockchain_metadata" + "contract_address", + "status", + "details", + "created_at", + "created_by" ] }, - "CancelOrdersResult": { + "Call": { "type": "object", "properties": { - "result": { - "$ref": "#/components/schemas/CancelOrdersResultData" + "target_address": { + "$ref": "#/components/schemas/Address" + }, + "function_signature": { + "type": "string", + "description": "The function signature", + "example": "mint(address,uint256)" + }, + "function_args": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The function arguments", + "example": [ + "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e", + "1" + ] } }, "required": [ - "result" - ], - "example": { - "result": { - "successful_cancellations": [ - "018a8c71-d7e4-e303-a2ef-318871ef7756", - "458a8c71-d7e4-e303-a2ef-318871ef7778" - ], - "pending_cancellations": [ - "238a8c71-d7e4-e303-a2ef-318871ef7778", - "898a8c71-d7e4-e303-a2ef-318871ef7735" - ], - "failed_cancellations": [ - { - "order": "458a8c71-d7e4-e303-a2ef-318871ef7790", - "reason_code": "FILLED" - }, - { - "order": "338a8c71-d7e4-e303-a2ef-318871ef7342", - "reason_code": "FILLED" - } - ] - } - } + "target_address", + "function_signature", + "function_args" + ] }, - "CancelOrdersResultData": { + "SignCraftingRequest": { "type": "object", "properties": { - "successful_cancellations": { - "type": "array", - "description": "Orders which were successfully cancelled", - "items": { - "type": "string" + "multi_caller": { + "type": "object", + "properties": { + "address": { + "$ref": "#/components/schemas/Address" + }, + "name": { + "type": "string", + "description": "The name of the multicaller contract", + "example": "Multicaller" + }, + "version": { + "type": "string", + "description": "The version of the multicaller contract", + "example": "1" + } }, - "minItems": 0, - "maxItems": 10 + "required": [ + "address", + "name", + "version" + ] }, - "pending_cancellations": { - "type": "array", - "description": "Orders which are marked for cancellation but the cancellation cannot be guaranteed", - "items": { - "type": "string" - }, - "minItems": 0, - "maxItems": 10 + "reference_id": { + "type": "string", + "description": "The id of this request in the system that originates the crafting request, specified as a 32 byte hex string", + "example": "67f7d464b8f04f6a9a3b8d3cb4a21af0" }, - "failed_cancellations": { + "calls": { "type": "array", - "description": "Orders which failed to be cancelled", + "description": "The calls to be signed", "items": { - "$ref": "#/components/schemas/FailedOrderCancellation" + "$ref": "#/components/schemas/Call" }, - "minItems": 0, - "maxItems": 10 + "minLength": 1, + "maxLength": 100 + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The expiration time of the request", + "example": "2022-08-16T17:43:26.991388Z" } }, "required": [ - "successful_cancellations", - "pending_cancellations", - "failed_cancellations" + "multi_caller", + "reference_id", + "calls", + "expires_at" ] }, - "FailedOrderCancellation": { + "SignCraftingResult": { "type": "object", "properties": { - "order": { - "type": "string", - "description": "ID of the order which failed to be cancelled", - "example": "7df3e99e-f7b3-459c-bef6-ffb66a18bb59" + "signer_address": { + "$ref": "#/components/schemas/Address" }, - "reason_code": { + "signature": { "type": "string", - "enum": [ - "FILLED" - ], - "description": "Reason code indicating why the order failed to be cancelled", - "example": "FILLED" + "description": "The signature of the request", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" } }, "required": [ - "order", - "reason_code" + "signer_address", + "signature" ] }, - "ListingResult": { + "BasicAPIError": { "type": "object", "properties": { - "result": { - "$ref": "#/components/schemas/Order" + "message": { + "type": "string", + "description": "Error Message", + "example": "all fields must be provided" + }, + "link": { + "type": "string", + "description": "Link to IMX documentation that can help resolve this error", + "example": "https://docs.immutable.com/zkevm/api/reference/" + }, + "trace_id": { + "type": "string", + "description": "Trace ID of the initial request", + "example": "e47634b79a5cd6894ddc9639ec4aad26" } }, "required": [ - "result" - ], - "example": { - "result": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "buy": [ - { - "type": "ERC20", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + "message", + "link", + "trace_id" + ] + }, + "APIError400": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "VALIDATION_ERROR" + ], + "example": "VALIDATION_ERROR" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" } - ], - "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-9E05C598534B", - "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "protocol_data": { - "order_type": "FULL_RESTRICTED", - "counter": "1", - "zone_address": "0x12", - "seaport_address": "0x12", - "seaport_version": "1.5" - }, - "salt": "12686911856931635052326433555881236148", - "sell": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" + "required": [ + "code", + "details" + ] + } + ] + }, + "APIError404": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "RESOURCE_NOT_FOUND" + ], + "example": "RESOURCE_NOT_FOUND" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z", - "status": { - "name": "EXPIRED" - }, - "type": { - "name": "LISTING" }, - "updated_at": "2022-03-07T07:20:50.52Z" + "required": [ + "code", + "details" + ] } - } + ] }, - "BidResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/Order" - } - }, - "required": [ - "result" - ], - "example": { - "result": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "sell": [ - { - "type": "ERC20", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + "APIError500": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "INTERNAL_SERVER_ERROR" + ], + "example": "INTERNAL_SERVER_ERROR" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" } - ], - "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-9E05C598534B", - "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "protocol_data": { - "order_type": "FULL_RESTRICTED", - "counter": "1", - "zone_address": "0x12", - "seaport_address": "0x12", - "seaport_version": "1.5" + "required": [ + "code", + "details" + ] + } + ] + }, + "APIError401": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "UNAUTHORISED_REQUEST" + ], + "example": "UNAUTHORISED_REQUEST" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" + } }, - "salt": "12686911856931635052326433555881236148", - "buy": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" + "required": [ + "code", + "details" + ] + } + ] + }, + "APIError403": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "AUTHENTICATION_ERROR" + ], + "example": "AUTHENTICATION_ERROR" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z", - "status": { - "name": "EXPIRED" }, - "type": "BID", - "updated_at": "2022-03-07T07:20:50.52Z" + "required": [ + "code", + "details" + ] } - } + ] }, - "CollectionBidResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/Order" - } - }, - "required": [ - "result" - ], - "example": { - "result": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "sell": [ - { - "type": "ERC20", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + "APIError429": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "TOO_MANY_REQUESTS_ERROR" + ], + "example": "TOO_MANY_REQUESTS_ERROR" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" } - ], - "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", - "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" + "required": [ + "code", + "details" + ] + } + ] + }, + "APIError409": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "CONFLICT_ERROR" + ], + "example": "CONFLICT_ERROR" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error", + "additionalProperties": true } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z", - "status": { - "name": "EXPIRED" }, - "type": "COLLECTION_BID", - "updated_at": "2022-03-07T07:20:50.52Z" + "required": [ + "code", + "details" + ] + } + ] + }, + "Item": { + "oneOf": [ + { + "$ref": "#/components/schemas/NativeItem" + }, + { + "$ref": "#/components/schemas/ERC20Item" + }, + { + "$ref": "#/components/schemas/ERC721Item" + }, + { + "$ref": "#/components/schemas/ERC1155Item" + }, + { + "$ref": "#/components/schemas/ERC721CollectionItem" + }, + { + "$ref": "#/components/schemas/ERC1155CollectionItem" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "NATIVE": "#/components/schemas/NativeItem", + "ERC20": "#/components/schemas/ERC20Item", + "ERC721": "#/components/schemas/ERC721Item", + "ERC1155": "#/components/schemas/ERC1155Item", + "ERC721_COLLECTION": "#/components/schemas/ERC721CollectionItem", + "ERC1155_COLLECTION": "#/components/schemas/ERC1155CollectionItem" } } }, - "MetadataBidResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/Order" + "AssetCollectionItem": { + "oneOf": [ + { + "$ref": "#/components/schemas/ERC721CollectionItem" + }, + { + "$ref": "#/components/schemas/ERC1155CollectionItem" } - }, - "required": [ - "result" ], - "example": { - "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" + "discriminator": { + "propertyName": "type", + "mapping": { + "ERC721_COLLECTION": "#/components/schemas/ERC721CollectionItem", + "ERC1155_COLLECTION": "#/components/schemas/ERC1155CollectionItem" } } }, - "TraitFilter": { + "FulfillmentDataRequest": { "type": "object", - "description": "A trait filter used to match NFTs by metadata attribute", "properties": { - "trait_type": { + "order_id": { "type": "string", - "description": "The trait type (attribute name)", - "example": "Background" + "format": "uuid" }, - "values": { + "taker_address": { + "type": "string", + "description": "Address of the intended account fulfilling the order", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "pattern": "^0x[a-fA-F0-9]{40}$" + }, + "fees": { "type": "array", - "description": "The trait values to match against", "items": { - "type": "string" + "$ref": "#/components/schemas/Fee" }, - "minItems": 1, "example": [ - "Blue", - "Red" - ] + { + "type": "TAKER_ECOSYSTEM", + "amount": "2250000000000000000", + "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233" + } + ], + "minItems": 0, + "maxItems": 2 + }, + "token_id": { + "type": "string", + "description": "Token ID for the ERC721 or ERC1155 token when fulfilling a collection order", + "example": "123", + "pattern": "\\d+" } }, "required": [ - "trait_type", - "values" + "order_id", + "fees", + "taker_address" ] }, - "MetadataFieldFilter": { + "FulfillableOrder": { "type": "object", - "description": "A field-level filter used to match NFTs for a metadata bid. The\n`field_name` is either a top-level metadata field (`name`, `image`,\n`description`, `animation_url`, `external_url`, `youtube_url`) or an\nattribute identified by the `attribute:` prefix (e.g.\n`attribute:Background`). Values match case-insensitively; multiple\nvalues are OR'd, multiple filters on a bid are AND'd.\n", "properties": { - "field_name": { + "order": { + "$ref": "#/components/schemas/Order" + }, + "token_id": { "type": "string", - "description": "The metadata field name (top-level field or `attribute:`)", - "example": "attribute:Background" + "description": "Token ID for the ERC721 or ERC1155 token when fulfilling a collection order", + "example": "123", + "pattern": "\\d+" }, - "values": { - "type": "array", - "description": "The metadata field values to match against (OR semantics)", - "items": { - "type": "string" - }, - "minItems": 1, - "example": [ - "Blue", - "Red" - ] + "extra_data": { + "type": "string" } }, "required": [ - "field_name", - "values" + "extra_data", + "order" ] }, - "CreateMetadataBidRequestBody": { + "UnfulfillableOrder": { "type": "object", - "description": "Request body for creating a metadata bid. Exactly one of `metadata_id`\nor `metadata_criteria` must be provided.\n", "properties": { - "account_address": { + "order_id": { "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "pattern": "^0x[a-fA-F0-9]{40}$" + "description": "OrderID for the requested but unfulfillable order", + "example": "7df3e99e-f7b3-459c-bef6-ffb66a18bb59" }, - "order_hash": { + "token_id": { "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" + "description": "Token ID for the ERC721 or ERC1155 token when fulfilling a collection order", + "example": "123", + "pattern": "\\d+" }, - "metadata_id": { + "reason": { "type": "string", - "format": "uuid", - "description": "Metadata identifier that matching NFTs must have to fulfill this bid. Mutually exclusive with `metadata_criteria`.", - "example": "018792C9-4AD7-8EC4-4038-9E05C598534B" - }, - "metadata_criteria": { - "type": "array", - "description": "Field-level metadata filters that matching NFTs must satisfy to fulfill this bid. Mutually exclusive with `metadata_id`.", - "items": { - "$ref": "#/components/schemas/MetadataFieldFilter" - }, - "minItems": 1, - "example": [ - { - "field_name": "name", - "values": [ - "Cool Dragon" - ] - }, - { - "field_name": "attribute:Background", - "values": [ - "Blue", - "Red" - ] - } + "description": "Nullable string containing error reason if the signing is unsuccessful for the order", + "example": "Invalid order status INACTIVE for order 7df3e99e-f7b3-459c-bef6-ffb66a18bb59" + } + }, + "required": [ + "reason", + "order_id" + ] + }, + "NativeItem": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Token type user is offering, which in this case is the native IMX token", + "example": "NATIVE", + "enum": [ + "NATIVE" ] }, - "buy": { - "type": "array", - "description": "Buy item for metadata bid should either be ERC721 or ERC1155 collection item", - "items": { - "$ref": "#/components/schemas/AssetCollectionItem" - }, - "example": [ - { - "type": "ERC721_COLLECTION", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "amount": "1" - } - ], - "minItems": 1, - "maxItems": 1 - }, - "fees": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/components/schemas/Fee" - }, - "example": [], - "minItems": 0, - "maxItems": 2 - }, - "end_at": { + "amount": { "type": "string", - "description": "Time after which the Order is considered expired", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" - }, - "protocol_data": { - "$ref": "#/components/schemas/ProtocolData" - }, - "salt": { + "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", + "example": "9750000000000000000", + "pattern": "\\d+" + } + }, + "required": [ + "type", + "amount" + ] + }, + "ERC20Item": { + "type": "object", + "properties": { + "type": { "type": "string", - "description": "A random value added to the create Order request", - "example": "12686911856931635052326433555881236148" - }, - "sell": { - "type": "array", - "description": "Sell item for metadata bid should be an ERC20 item", - "items": { - "$ref": "#/components/schemas/ERC20Item" - }, - "example": [ - { - "type": "ERC20", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "amount": "9750000000000000000" - } - ], - "minItems": 1, - "maxItems": 1 + "description": "Token type user is offering, which in this case is ERC20", + "example": "ERC20", + "enum": [ + "ERC20" + ] }, - "signature": { + "contract_address": { "type": "string", - "description": "Digital signature generated by the user for the specific Order", - "example": "0x" + "description": "Address of ERC20 token", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "start_at": { + "amount": { "type": "string", - "description": "Time after which Order is considered active", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" + "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", + "example": "9750000000000000000", + "pattern": "\\d+" } }, - "example": { - "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" - }, "required": [ - "account_address", - "order_hash", - "buy", - "sell", - "fees", - "end_at", - "start_at", - "protocol_data", - "salt", - "signature" + "type", + "contract_address", + "amount" + ] + }, + "ERC721Item": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Token type user is offering, which in this case is ERC721", + "example": "ERC721", + "enum": [ + "ERC721" + ] + }, + "contract_address": { + "type": "string", + "description": "Address of ERC721 token", + "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "pattern": "^0x[a-fA-F0-9]{40}$" + }, + "token_id": { + "type": "string", + "description": "ID of ERC721 token", + "example": "1", + "pattern": "\\d+" + } + }, + "required": [ + "type", + "contract_address", + "token_id" ] }, - "CreateTraitBidRequestBody": { + "ERC1155Item": { "type": "object", "properties": { - "account_address": { - "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, - "order_hash": { - "type": "string", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" - }, - "buy": { - "type": "array", - "description": "Buy item for trait bid should either be ERC721 or ERC1155 collection item", - "items": { - "$ref": "#/components/schemas/AssetCollectionItem" - }, - "example": [ - { - "type": "ERC721_COLLECTION", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "amount": "1" - } - ], - "minItems": 1, - "maxItems": 1 - }, - "fees": { - "type": "array", - "description": "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.", - "items": { - "$ref": "#/components/schemas/Fee" - }, - "example": [], - "minItems": 0, - "maxItems": 2 - }, - "end_at": { + "type": { "type": "string", - "description": "Time after which the Order is considered expired", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" - }, - "protocol_data": { - "$ref": "#/components/schemas/ProtocolData" + "description": "Token type user is offering, which in this case is ERC1155", + "example": "ERC1155", + "enum": [ + "ERC1155" + ] }, - "salt": { + "contract_address": { "type": "string", - "description": "A random value added to the create Order request", - "example": "12686911856931635052326433555881236148" - }, - "sell": { - "type": "array", - "description": "Sell item for trait bid should be an ERC20 item", - "items": { - "$ref": "#/components/schemas/ERC20Item" - }, - "example": [ - { - "type": "ERC20", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "amount": "9750000000000000000" - } - ], - "minItems": 1, - "maxItems": 1 + "description": "Address of ERC1155 token", + "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "signature": { + "token_id": { "type": "string", - "description": "Digital signature generated by the user for the specific Order", - "example": "0x" + "description": "ID of ERC1155 token", + "example": "1", + "pattern": "\\d+" }, - "start_at": { + "amount": { "type": "string", - "description": "Time after which Order is considered active", - "format": "date-time", - "example": "2022-03-09T05:00:50.52Z" - }, - "trait_criteria": { - "type": "array", - "description": "Trait criteria to match NFTs against", - "items": { - "$ref": "#/components/schemas/TraitFilter" - }, - "minItems": 1, - "example": [ - { - "trait_type": "Background", - "values": [ - "Blue", - "Red" - ] - } - ] + "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", + "example": "9750000000000000000", + "pattern": "\\d+" } }, - "example": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770", - "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", - "trait_criteria": [ - { - "trait_type": "Background", - "values": [ - "Blue", - "Red" - ] - } - ] - }, "required": [ - "account_address", - "order_hash", - "buy", - "sell", - "fees", - "end_at", - "start_at", - "protocol_data", - "salt", - "signature", - "trait_criteria" + "type", + "contract_address", + "token_id", + "amount" ] }, - "TraitBidResult": { + "ERC721CollectionItem": { "type": "object", "properties": { - "result": { - "$ref": "#/components/schemas/Order" + "type": { + "type": "string", + "description": "Token type user is offering, which in this case is ERC721", + "example": "ERC721_COLLECTION", + "enum": [ + "ERC721_COLLECTION" + ] + }, + "contract_address": { + "type": "string", + "description": "Address of ERC721 collection", + "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "pattern": "^0x[a-fA-F0-9]{40}$" + }, + "amount": { + "type": "string", + "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", + "example": "9750000000000000000", + "pattern": "\\d+" } }, "required": [ - "result" - ], - "example": { - "result": { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "sell": [ - { - "type": "ERC20", - "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", - "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": "TRAIT_BID", - "updated_at": "2022-03-07T07:20:50.52Z" - } - } + "type", + "contract_address", + "amount" + ] }, - "ListTraitBidsResult": { + "ERC1155CollectionItem": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/Page" + "type": { + "type": "string", + "description": "Token type user is offering, which in this case is ERC1155", + "example": "ERC1155_COLLECTION", + "enum": [ + "ERC1155_COLLECTION" + ] }, - "result": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - }, - "minItems": 0, - "maxItems": 200 + "contract_address": { + "type": "string", + "description": "Address of ERC1155 collection", + "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "pattern": "^0x[a-fA-F0-9]{40}$" + }, + "amount": { + "type": "string", + "description": "A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).", + "example": "9750000000000000000", + "pattern": "\\d+" } }, "required": [ - "page", - "result" + "type", + "contract_address", + "amount" ] }, - "ListMetadataBidsResult": { + "CancelOrdersRequestBody": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/Page" + "account_address": { + "type": "string", + "description": "Address of the user initiating the cancel request", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "result": { + "orders": { "type": "array", + "description": "List of order ids proposed for cancellation", "items": { - "$ref": "#/components/schemas/Order" + "type": "string", + "format": "uuid" }, - "minItems": 0, - "maxItems": 200 + "uniqueItems": true, + "minItems": 1, + "maxItems": 20 + }, + "signature": { + "type": "string", + "description": "Signature generated by the user for the specific cancellation request", + "example": "0x12345" } }, "required": [ - "page", - "result" - ] + "account_address", + "orders", + "signature" + ], + "example": { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "ids": [ + "018a8c71-d7e4-e303-a2ef-318871ef7756", + "238a8c71-d7e4-e303-a2ef-318871ef7778", + "458a8c71-d7e4-e303-a2ef-318871ef7790" + ], + "signature": 291 + } }, - "ListListingsResult": { + "CreateListingRequestBody": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/Page" + "account_address": { + "type": "string", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "result": { + "order_hash": { + "type": "string", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" + }, + "buy": { "type": "array", + "description": "Buy item for listing should either be NATIVE or ERC20 item", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/Item" + }, + "example": [ + { + "type": "NATIVE", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "fees": { + "type": "array", + "description": "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.", + "items": { + "$ref": "#/components/schemas/Fee" }, + "example": [], "minItems": 0, - "maxItems": 200 + "maxItems": 2 + }, + "end_at": { + "type": "string", + "description": "Time after which the Order is considered expired", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" + }, + "protocol_data": { + "$ref": "#/components/schemas/ProtocolData" + }, + "salt": { + "type": "string", + "description": "A random value added to the create Order request", + "example": "12686911856931635052326433555881236148" + }, + "sell": { + "type": "array", + "description": "Sell item for listing should be an ERC721 item", + "items": { + "$ref": "#/components/schemas/Item" + }, + "example": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "signature": { + "type": "string", + "description": "Digital signature generated by the user for the specific Order", + "example": "0x" + }, + "start_at": { + "type": "string", + "description": "Time after which Order is considered active", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" } }, - "required": [ - "page", - "result" - ], "example": { - "page": { - "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA", - "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA" - }, - "result": [ + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770", + "buy": [ { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "buy": [ - { - "type": "ERC20", - "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", - "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "protocol_data": { - "order_type": "FULL_RESTRICTED", - "counter": "1", - "zone_address": "0x12", - "seaport_address": "0x12", - "seaport_version": "1.5" - }, - "salt": "12686911856931635052326433555881236148", - "sell": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z", - "status": { - "name": "EXPIRED" - }, - "updated_at": "2022-03-07T07:20:50.52Z" - }, + "type": "NATIVE", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "fees": [ { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "buy": [ - { - "type": "ERC20", - "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", - "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "protocol_data": { - "order_type": "FULL_RESTRICTED", - "counter": "1", - "zone_address": "0x12", - "seaport_address": "0x12", - "seaport_version": "1.5" - }, - "salt": "12686911856931635052326433555881236148", - "sell": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z", - "status": { - "name": "EXPIRED" - }, - "updated_at": "2022-03-07T07:20:50.52Z" + "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.4" + }, + "salt": "12686911856931635052326433555881236148", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z" + }, + "required": [ + "account_address", + "order_hash", + "buy", + "sell", + "fees", + "end_at", + "start_at", + "protocol_data", + "salt", + "signature" + ] }, - "ListBidsResult": { + "CreateBidRequestBody": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/Page" + "account_address": { + "type": "string", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "result": { + "order_hash": { + "type": "string", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" + }, + "buy": { + "type": "array", + "description": "Buy item for bid should either be ERC721 or ERC1155 item", + "items": { + "$ref": "#/components/schemas/Item" + }, + "example": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "fees": { "type": "array", + "description": "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.", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/Fee" }, + "example": [], "minItems": 0, - "maxItems": 200 + "maxItems": 2 + }, + "end_at": { + "type": "string", + "description": "Time after which the Order is considered expired", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" + }, + "protocol_data": { + "$ref": "#/components/schemas/ProtocolData" + }, + "salt": { + "type": "string", + "description": "A random value added to the create Order request", + "example": "12686911856931635052326433555881236148" + }, + "sell": { + "type": "array", + "description": "Sell item for bid should be an ERC20 item", + "items": { + "$ref": "#/components/schemas/ERC20Item" + }, + "example": [ + { + "type": "ERC20", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "amount": "9750000000000000000" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "signature": { + "type": "string", + "description": "Digital signature generated by the user for the specific Order", + "example": "0x" + }, + "start_at": { + "type": "string", + "description": "Time after which Order is considered active", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" } }, - "required": [ - "page", - "result" - ], "example": { - "page": { - "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA", - "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA" - }, - "result": [ + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770", + "sell": [ { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "sell": [ - { - "type": "ERC20", - "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", - "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "protocol_data": { - "order_type": "FULL_RESTRICTED", - "counter": "1", - "zone_address": "0x12", - "seaport_address": "0x12", - "seaport_version": "1.5" - }, - "salt": "12686911856931635052326433555881236148", - "buy": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z", - "status": { - "name": "EXPIRED" - }, - "updated_at": "2022-03-07T07:20:50.52Z" - }, + "type": "ERC20", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "fees": [ { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "sell": [ - { - "type": "ERC20", - "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", - "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "protocol_data": { - "order_type": "FULL_RESTRICTED", - "counter": "1", - "zone_address": "0x12", - "seaport_address": "0x12", - "seaport_version": "1.5" - }, - "salt": "12686911856931635052326433555881236148", - "buy": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "signature": "0x", - "start_at": "2022-03-09T05:00:50.52Z", - "status": { - "name": "EXPIRED" - }, - "updated_at": "2022-03-07T07:20:50.52Z" + "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", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z" + }, + "required": [ + "account_address", + "order_hash", + "buy", + "sell", + "fees", + "end_at", + "start_at", + "protocol_data", + "salt", + "signature" + ] }, - "ListCollectionBidsResult": { + "CreateCollectionBidRequestBody": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/Page" + "account_address": { + "type": "string", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "result": { + "order_hash": { + "type": "string", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" + }, + "buy": { + "type": "array", + "description": "Buy item for collection bid should either be ERC721 or ERC1155 collection item", + "items": { + "$ref": "#/components/schemas/AssetCollectionItem" + }, + "example": [ + { + "type": "ERC721_COLLECTION", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "amount": "1" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "fees": { "type": "array", + "description": "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.", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/Fee" }, + "example": [], "minItems": 0, - "maxItems": 200 + "maxItems": 2 + }, + "end_at": { + "type": "string", + "description": "Time after which the Order is considered expired", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" + }, + "protocol_data": { + "$ref": "#/components/schemas/ProtocolData" + }, + "salt": { + "type": "string", + "description": "A random value added to the create Order request", + "example": "12686911856931635052326433555881236148" + }, + "sell": { + "type": "array", + "description": "Sell item for collection bid should be an ERC20 item", + "items": { + "$ref": "#/components/schemas/ERC20Item" + }, + "example": [ + { + "type": "ERC20", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "amount": "9750000000000000000" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "signature": { + "type": "string", + "description": "Digital signature generated by the user for the specific Order", + "example": "0x" + }, + "start_at": { + "type": "string", + "description": "Time after which Order is considered active", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" } }, - "required": [ - "page", - "result" - ], "example": { - "page": { - "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA", - "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA" - }, - "result": [ + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770", + "sell": [ { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "sell": [ - { - "type": "ERC20", - "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", - "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" - }, - "updated_at": "2022-03-07T07:20:50.52Z" - }, + "type": "ERC20", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "fees": [ { - "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", - "sell": [ - { - "type": "ERC20", - "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", - "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" - }, - "updated_at": "2022-03-07T07:20:50.52Z" + "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" + }, + "required": [ + "account_address", + "order_hash", + "buy", + "sell", + "fees", + "end_at", + "start_at", + "protocol_data", + "salt", + "signature" + ] }, - "TradeResult": { + "Fee": { "type": "object", "properties": { - "result": { - "$ref": "#/components/schemas/Trade" + "amount": { + "type": "string", + "description": "Fee payable to recipient upon settlement", + "example": "2250000000000000000", + "pattern": "\\d+" + }, + "type": { + "type": "string", + "description": "Fee type", + "example": "ROYALTY", + "enum": [ + "ROYALTY", + "MAKER_ECOSYSTEM", + "TAKER_ECOSYSTEM", + "PROTOCOL" + ] + }, + "recipient_address": { + "type": "string", + "description": "Wallet address of fee recipient", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233", + "pattern": "^0x[a-fA-F0-9]{40}$" } }, - "required": [ - "result" - ], "example": { - "result": { - "buy": [ + "amount": "2250000000000000000", + "type": "ROYALTY", + "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233" + }, + "required": [ + "type", + "amount", + "recipient_address" + ] + }, + "Order": { + "type": "object", + "properties": { + "account_address": { + "type": "string", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" + }, + "buy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Item" + }, + "example": [ { - "type": "ERC20", + "type": "NATIVE", "amount": "9750000000000000000", "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" } ], - "buyer_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", - "buyer_fees": [], - "chain": { - "id": "eip155:11155111", - "name": "sepolia" + "minItems": 1, + "maxItems": 1 + }, + "fees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Fee" + }, + "example": [], + "minItems": 0 + }, + "chain": { + "$ref": "#/components/schemas/Chain" + }, + "created_at": { + "type": "string", + "description": "Time the Order is created", + "format": "date-time", + "example": "2022-03-07T07:20:50.52Z" + }, + "end_at": { + "type": "string", + "description": "Time after which the Order is considered expired", + "format": "date-time", + "example": "2022-03-10T05:00:50.52Z" + }, + "id": { + "type": "string", + "description": "Global Order identifier", + "example": "018792C9-4AD7-8EC4-4038-9E05C598534A" + }, + "order_hash": { + "type": "string", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" + }, + "protocol_data": { + "$ref": "#/components/schemas/ProtocolData" + }, + "salt": { + "type": "string", + "description": "A random value added to the create Order request", + "example": "12686911856931635052326433555881236148" + }, + "sell": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Item" }, - "created_at": "2022-03-07T07:20:50.52Z", - "id": "018792C9-4AD7-8EC4-4038-9E05C598534B", - "sell": [ + "example": [ { "type": "ERC721", "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", "token_id": "1" } ], - "seller_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", - "maker_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", - "taker_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", - "updated_at": "2022-03-07T07:20:50.52Z" - } - } - }, - "ListTradeResult": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/Page" + "minItems": 1, + "maxItems": 1 }, - "result": { + "signature": { + "type": "string", + "description": "Digital signature generated by the user for the specific Order", + "example": "0x" + }, + "start_at": { + "type": "string", + "description": "Time after which Order is considered active", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" + }, + "status": { + "$ref": "#/components/schemas/OrderStatus" + }, + "type": { + "type": "string", + "description": "Order type", + "example": "LISTING", + "enum": [ + "LISTING", + "BID", + "COLLECTION_BID", + "TRAIT_BID", + "METADATA_BID" + ] + }, + "updated_at": { + "type": "string", + "description": "Time the Order is last updated", + "format": "date-time", + "example": "2022-03-07T07:20:50.52Z" + }, + "fill_status": { + "$ref": "#/components/schemas/FillStatus" + }, + "trait_criteria": { "type": "array", + "description": "Trait filters for TRAIT_BID orders; omitted for other order types.", "items": { - "$ref": "#/components/schemas/Trade" + "$ref": "#/components/schemas/TraitFilter" }, - "minItems": 0, - "maxItems": 200 + "minItems": 1, + "example": [ + { + "trait_type": "Background", + "values": [ + "Blue", + "Red" + ] + } + ] + }, + "metadata_id": { + "type": "string", + "format": "uuid", + "description": "Metadata identifier for METADATA_BID orders created with a single metadata stack. Omitted for other order types and for metadata bids created with `metadata_criteria`.", + "example": "018792C9-4AD7-8EC4-4038-9E05C598534B" + }, + "metadata_criteria": { + "type": "array", + "description": "Field-level metadata filters for METADATA_BID orders created with criteria instead of a `metadata_id`. Omitted for other order types and for metadata bids created with a `metadata_id`.", + "items": { + "$ref": "#/components/schemas/MetadataFieldFilter" + }, + "minItems": 1, + "example": [ + { + "field_name": "name", + "values": [ + "Cool Dragon" + ] + }, + { + "field_name": "attribute:Background", + "values": [ + "Blue", + "Red" + ] + } + ] } }, - "required": [ - "page", - "result" - ], "example": { - "page": { - "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA", - "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA" - }, - "result": [ - { - "buy": [ - { - "type": "ERC20", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - } - ], - "buyer_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", - "buyer_fees": [], - "chain": { - "id": "eip155:11155111", - "name": "sepolia" - }, - "created_at": "2022-03-07T07:20:50.52Z", - "id": "018792C9-4AD7-8EC4-4038-9E05C598534A", - "sell": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "seller_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", - "maker_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", - "taker_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", - "updated_at": "2022-03-07T07:20:50.52Z" - }, + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "buy": [ { - "buy": [ - { - "type": "ERC20", - "amount": "9750000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - } - ], - "buyer_address": "0x017406f3F27d507a1491976B7835CE5CD0fA647a", - "buyer_fees": [], - "chain": { - "id": "eip155:11155111", - "name": "sepolia" - }, - "created_at": "2022-03-07T07:20:50.52Z", - "id": "018792C9-4AD7-8EC4-4038-9E05C598534A", - "sell": [ - { - "type": "ERC721", - "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "token_id": "1" - } - ], - "seller_address": "0xC73349c545C1D757eb650cDc463A2f6dF1Ec41cb", - "maker_address": "0xC73349c545C1D757eb650cDc463A2f6dF1Ec41cb", - "taker_address": "0x017406f3F27d507a1491976B7835CE5CD0fA647a", - "updated_at": "2022-03-07T07:20:50.52Z" + "type": "NATIVE", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" } - ] - } - }, - "OrderStatus": { - "description": "The Order status", - "oneOf": [ - { - "$ref": "#/components/schemas/CancelledOrderStatus" - }, - { - "$ref": "#/components/schemas/PendingOrderStatus" - }, - { - "$ref": "#/components/schemas/ActiveOrderStatus" - }, - { - "$ref": "#/components/schemas/InactiveOrderStatus" + ], + "fees": [], + "chain": { + "id": "eip155:11155111", + "name": "sepolia" }, - { - "$ref": "#/components/schemas/FilledOrderStatus" + "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" }, - { - "$ref": "#/components/schemas/ExpiredOrderStatus" - } - ], - "discriminator": { - "propertyName": "name", - "mapping": { - "CANCELLED": "#/components/schemas/CancelledOrderStatus", - "PENDING": "#/components/schemas/PendingOrderStatus", - "ACTIVE": "#/components/schemas/ActiveOrderStatus", - "INACTIVE": "#/components/schemas/InactiveOrderStatus", - "FILLED": "#/components/schemas/FilledOrderStatus", - "EXPIRED": "#/components/schemas/ExpiredOrderStatus" - } - } - }, - "CancelledOrderStatus": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The order status indicating a order is has been cancelled or about to be cancelled.", - "enum": [ - "CANCELLED" - ] + "salt": "12686911856931635052326433555881236148", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z", + "status": { + "name": "ACTIVE" }, - "pending": { - "type": "boolean", - "description": "Whether the cancellation of the order is pending", - "example": false + "fill_status": { + "numerator": 1, + "denominator": 2 }, - "cancellation_type": { - "type": "string", - "description": "Whether the cancellation was done on-chain or off-chain or as a result of an underfunded account", - "enum": [ - "ON_CHAIN", - "OFF_CHAIN", - "UNDERFUNDED" - ], - "example": "ON_CHAIN" - } + "type": "LISTING", + "updated_at": "2022-03-07T07:20:50.52Z" }, "required": [ - "name", - "pending", - "cancellation_type" + "id", + "type", + "account_address", + "buy", + "sell", + "fees", + "chain", + "created_at", + "end_at", + "start_at", + "updated_at", + "order_hash", + "protocol_data", + "salt", + "signature", + "status", + "fill_status" ] }, - "PendingOrderStatus": { + "Trade": { "type": "object", "properties": { - "name": { + "buy": { + "description": "Buy items are transferred from the taker to the maker.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Item" + }, + "example": [ + { + "type": "NATIVE", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "buyer_address": { + "description": "Deprecated. Use maker and taker addresses instead of buyer and seller addresses.", "type": "string", - "description": "The order status that indicates the order is yet to be active due to various reasons.", - "enum": [ - "PENDING" - ] + "example": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40" }, - "evaluated": { - "type": "boolean", - "description": "Whether the order has been evaluated after its creation", - "example": false + "buyer_fees": { + "description": "Deprecated. Use fees instead. The taker always pays the fees.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Fee" + }, + "example": [], + "minItems": 0, + "maxItems": 1 }, - "started": { - "type": "boolean", - "description": "Whether the order has reached its specified start time", - "example": false - } - }, - "required": [ - "name", - "evaluated", - "started" - ] - }, - "ActiveOrderStatus": { - "type": "object", - "properties": { - "name": { + "fees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Fee" + }, + "example": [], + "minItems": 0, + "maxItems": 1 + }, + "chain": { + "$ref": "#/components/schemas/Chain" + }, + "order_id": { "type": "string", - "description": "The order status that indicates an order can be fulfilled.", - "enum": [ - "ACTIVE" - ] - } - }, - "required": [ - "name" - ] - }, - "InactiveOrderStatus": { - "type": "object", - "properties": { - "name": { + "example": "7df3e99e-f7b3-459c-bef6-ffb66a18bb59" + }, + "blockchain_metadata": { + "$ref": "#/components/schemas/TradeBlockchainMetadata" + }, + "indexed_at": { "type": "string", - "description": "The order status that indicates an order cannot be fulfilled.", - "enum": [ - "INACTIVE" - ] + "description": "Time the on-chain trade event is indexed by the order book system", + "format": "date-time", + "example": "2022-03-07T07:20:50.52Z" }, - "sufficient_approvals": { - "type": "boolean", - "description": "Whether the order offerer has sufficient approvals", - "example": false + "id": { + "type": "string", + "description": "Global Trade identifier", + "example": "018792C9-4AD7-8EC4-4038-9E05C598534A" }, - "sufficient_balances": { - "type": "boolean", - "description": "Whether the order offerer still has sufficient balance to complete the order", - "example": false - } - }, - "required": [ - "name", - "sufficient_approvals", - "sufficient_balances" - ] - }, - "ExpiredOrderStatus": { - "type": "object", - "properties": { - "name": { + "sell": { + "description": "Sell items are transferred from the maker to the taker.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Item" + }, + "example": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "seller_address": { + "description": "Deprecated. Use maker and taker addresses instead of buyer and seller addresses.", "type": "string", - "description": "A terminal order status indicating that an order cannot be fulfilled due to expiry.", - "enum": [ - "EXPIRED" - ] - } - }, - "required": [ - "name" - ] - }, - "FilledOrderStatus": { - "type": "object", - "properties": { - "name": { + "example": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D" + }, + "maker_address": { "type": "string", - "description": "A terminal order status indicating that an order has been fulfilled.", - "enum": [ - "FILLED" - ] + "example": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D" + }, + "taker_address": { + "type": "string", + "example": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40" } }, + "example": { + "buy": [ + { + "type": "NATIVE", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "buyer_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", + "buyer_fees": [], + "fees": [], + "chain": { + "id": "eip155:11155111", + "name": "sepolia" + }, + "indexed_at": "2022-03-07T07:20:50.52Z", + "id": "018792C9-4AD7-8EC4-4038-9E05C598534A", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "seller_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", + "maker_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", + "taker_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40" + }, "required": [ - "name" - ] - }, - "OrderStatusName": { - "type": "string", - "description": "The Order status", - "enum": [ - "PENDING", - "ACTIVE", - "INACTIVE", - "FILLED", - "EXPIRED", - "CANCELLED" + "id", + "order_id", + "buy", + "buyer_address", + "sell", + "seller_address", + "buyer_fees", + "fees", + "chain", + "maker_address", + "taker_address", + "indexed_at", + "blockchain_metadata" ] }, - "ProtocolData": { + "CancelOrdersResult": { "type": "object", "properties": { - "order_type": { - "type": "string", - "description": "Seaport order type. Orders containing ERC721 tokens will need to pass in the order type as FULL_RESTRICTED while orders with ERC1155 tokens will need to pass in the order_type as PARTIAL_RESTRICTED", - "example": "FULL_RESTRICTED", - "enum": [ - "FULL_RESTRICTED", - "PARTIAL_RESTRICTED" - ] - }, - "counter": { - "type": "string", - "description": "big.Int or uint256 string for order counter", - "example": "92315562" - }, - "zone_address": { - "type": "string", - "description": "Immutable zone address", - "example": "0x12" - }, - "seaport_address": { - "type": "string", - "description": "Immutable Seaport contract address", - "example": "0x12" - }, - "seaport_version": { - "type": "string", - "description": "Immutable Seaport contract version", - "example": "1.5" + "result": { + "$ref": "#/components/schemas/CancelOrdersResultData" } }, - "example": { - "order_type": "FULL_RESTRICTED", - "counter": "92315562", - "zone_address": "0x12", - "seaport_address": "0x12", - "seaport_version": "1.5" - }, "required": [ - "order_type", - "counter", - "zone_address", - "seaport_address", - "seaport_version" - ] + "result" + ], + "example": { + "result": { + "successful_cancellations": [ + "018a8c71-d7e4-e303-a2ef-318871ef7756", + "458a8c71-d7e4-e303-a2ef-318871ef7778" + ], + "pending_cancellations": [ + "238a8c71-d7e4-e303-a2ef-318871ef7778", + "898a8c71-d7e4-e303-a2ef-318871ef7735" + ], + "failed_cancellations": [ + { + "order": "458a8c71-d7e4-e303-a2ef-318871ef7790", + "reason_code": "FILLED" + }, + { + "order": "338a8c71-d7e4-e303-a2ef-318871ef7342", + "reason_code": "FILLED" + } + ] + } + } }, - "TradeBlockchainMetadata": { - "description": "The metadata related to the transaction in which the activity occurred", - "nullable": true, + "CancelOrdersResultData": { "type": "object", "properties": { - "transaction_hash": { - "type": "string", - "description": "The transaction hash of the trade", - "example": "0x68d9eac5e3b3c3580404989a4030c948a78e1b07b2b5ea5688d8c38a6c61c93e" - }, - "block_number": { - "description": "EVM block number (uint64 as string)", - "type": "string", - "example": "1" + "successful_cancellations": { + "type": "array", + "description": "Orders which were successfully cancelled", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 10 }, - "transaction_index": { - "description": "Transaction index in a block (uint32 as string)", - "type": "string", - "example": "1" + "pending_cancellations": { + "type": "array", + "description": "Orders which are marked for cancellation but the cancellation cannot be guaranteed", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 10 }, - "log_index": { - "description": "The log index of the fulfillment event in a block (uint32 as string)", - "type": "string", - "example": "1" + "failed_cancellations": { + "type": "array", + "description": "Orders which failed to be cancelled", + "items": { + "$ref": "#/components/schemas/FailedOrderCancellation" + }, + "minItems": 0, + "maxItems": 10 } }, "required": [ - "transaction_hash", - "block_number", - "transaction_index", - "log_index" + "successful_cancellations", + "pending_cancellations", + "failed_cancellations" ] }, - "FillStatus": { - "description": "The ratio of the order that has been filled, an order that has been fully filled will have the same numerator and denominator values.", + "FailedOrderCancellation": { "type": "object", "properties": { - "numerator": { + "order": { "type": "string", - "description": "The numerator of the fill status", - "example": "1" + "description": "ID of the order which failed to be cancelled", + "example": "7df3e99e-f7b3-459c-bef6-ffb66a18bb59" }, - "denominator": { + "reason_code": { "type": "string", - "description": "The denominator of the fill status", - "example": "2" + "enum": [ + "FILLED" + ], + "description": "Reason code indicating why the order failed to be cancelled", + "example": "FILLED" } }, "required": [ - "numerator", - "denominator" + "order", + "reason_code" ] }, - "APIError501": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" - }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "NOT_IMPLEMENTED_ERROR" - ], - "example": "NOT_IMPLEMENTED_ERROR" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" - } - }, - "required": [ - "code", - "details" - ] + "ListingResult": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Order" } - ] - }, - "APIError503": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" - }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "SERVICE_UNAVAILABLE" - ], - "example": "SERVICE_UNAVAILABLE" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" + }, + "required": [ + "result" + ], + "example": { + "result": { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "buy": [ + { + "type": "ERC20", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" } + ], + "fees": [], + "chain": { + "id": "eip155:11155111", + "name": "sepolia" }, - "required": [ - "code", - "details" - ] - } - ] - }, - "APIError504": { - "allOf": [ - { - "$ref": "#/components/schemas/BasicAPIError" - }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Error Code", - "enum": [ - "GATEWAY_TIMEOUT" - ], - "example": "GATEWAY_TIMEOUT" - }, - "details": { - "type": "object", - "nullable": true, - "description": "Additional details to help resolve the error" + "created_at": "2022-03-07T07:20:50.52Z", + "end_at": "2022-03-10T05:00:50.52Z", + "id": "018792C9-4AD7-8EC4-4038-9E05C598534B", + "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "protocol_data": { + "order_type": "FULL_RESTRICTED", + "counter": "1", + "zone_address": "0x12", + "seaport_address": "0x12", + "seaport_version": "1.5" + }, + "salt": "12686911856931635052326433555881236148", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z", + "status": { + "name": "EXPIRED" }, - "required": [ - "code", - "details" - ] + "type": { + "name": "LISTING" + }, + "updated_at": "2022-03-07T07:20:50.52Z" } - ] + } }, - "CreateCounterfactualAddressRequest": { + "BidResult": { "type": "object", - "required": [ - "ethereum_address", - "ethereum_signature" - ], "properties": { - "ethereum_address": { - "description": "The user's UAK address", - "type": "string", - "maxLength": 42 - }, - "ethereum_signature": { - "description": "The signature generated with the UAK", - "type": "string", - "maxLength": 132 + "result": { + "$ref": "#/components/schemas/Order" } }, - "additionalProperties": false - }, - "GetTransactionMetadataRequest": { - "type": "object", "required": [ - "contract_address", - "method_id", - "transaction_id", - "transaction_data" + "result" ], - "properties": { - "contract_address": { - "description": "The address of the contract intended for interaction with this transaction", - "type": "string", - "pattern": "^0x[0-9a-fA-F]*$", - "maxLength": 42 - }, - "method_id": { - "description": "The method ID of the contract intended for interaction with this transaction", - "type": "string", - "maxLength": 132 - }, - "transaction_id": { - "description": "ID of the given transaction to be decoded", - "type": "string" - }, - "transaction_data": { - "description": "Encoded transaction data", - "pattern": "^0x[0-9a-fA-F]*$", - "type": "string" + "example": { + "result": { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "sell": [ + { + "type": "ERC20", + "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-9E05C598534B", + "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "protocol_data": { + "order_type": "FULL_RESTRICTED", + "counter": "1", + "zone_address": "0x12", + "seaport_address": "0x12", + "seaport_version": "1.5" + }, + "salt": "12686911856931635052326433555881236148", + "buy": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z", + "status": { + "name": "EXPIRED" + }, + "type": "BID", + "updated_at": "2022-03-07T07:20:50.52Z" } - }, - "additionalProperties": false + } }, - "CreateCounterfactualAddressRes": { + "CollectionBidResult": { "type": "object", - "required": [ - "counterfactual_address" - ], "properties": { - "counterfactual_address": { - "description": "The user's counterfactual address", - "type": "string", - "maxLength": 42 + "result": { + "$ref": "#/components/schemas/Order" } - } - }, - "GetLinkedAddressesResDeprecated": { - "type": "object", + }, "required": [ - "linkedAddresses" + "result" ], - "properties": { - "linkedAddresses": { - "type": "array", - "minItems": 0, - "description": "The user's list of linked addresses", - "items": { - "description": "The user's linked address", - "type": "string", - "pattern": "^0x[0-9a-fA-F]*$", - "maxLength": 42 - } + "example": { + "result": { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "sell": [ + { + "type": "ERC20", + "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", + "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": "COLLECTION_BID", + "updated_at": "2022-03-07T07:20:50.52Z" } } }, - "GetPassportMetadataRes": { + "MetadataBidResult": { "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Order" + } + }, "required": [ - "passport_metadata" + "result" ], - "properties": { - "passport_metadata": { - "type": "array", - "minItems": 0, - "description": "The user's passport metadata", - "items": { - "description": "The user's passport metadata", - "type": "object", - "properties": { - "chain_id": { - "type": "string", - "description": "The chain id (eg: eip155:1)" - }, - "chain_key": { - "type": "string", - "description": "The chain key" - }, - "user_admin_key": { - "type": "string", - "description": "The user admin key" - }, - "counterfactual_address": { - "type": "string", - "description": "The counterfactual address" - } + "example": { + "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" } } }, - "GetLinkedAddressesRes": { + "TraitFilter": { "type": "object", - "required": [ - "linked_addresses" - ], + "description": "A trait filter used to match NFTs by metadata attribute", "properties": { - "linked_addresses": { + "trait_type": { + "type": "string", + "description": "The trait type (attribute name)", + "example": "Background" + }, + "values": { "type": "array", - "minItems": 0, - "description": "The user's list of linked addresses", + "description": "The trait values to match against", "items": { - "description": "The user's linked address", - "type": "string", - "pattern": "^0x[0-9a-fA-F]*$", - "maxLength": 42 - } + "type": "string" + }, + "minItems": 1, + "example": [ + "Blue", + "Red" + ] } - } - }, - "ImmutableVerificationStatusEnum": { - "type": "string", - "enum": [ - "verified", - "unverified", - "spam", - "inactive" + }, + "required": [ + "trait_type", + "values" ] }, - "ERC721ApproveMetadata": { + "MetadataFieldFilter": { "type": "object", - "required": [ - "transaction_type", - "collection_name", - "collection_image", - "asset_image", - "asset_name", - "is_smart_contract", - "is_contract_verified", - "contract_name", - "token_id", - "immutable_verification_status" - ], + "description": "A field-level filter used to match NFTs for a metadata bid. The\n`field_name` is either a top-level metadata field (`name`, `image`,\n`description`, `animation_url`, `external_url`, `youtube_url`) or an\nattribute identified by the `attribute:` prefix (e.g.\n`attribute:Background`). Values match case-insensitively; multiple\nvalues are OR'd, multiple filters on a bid are AND'd.\n", "properties": { - "transaction_type": { + "field_name": { "type": "string", - "description": "Transaction type", - "enum": [ - "ERC721_APPROVE" - ] + "description": "The metadata field name (top-level field or `attribute:`)", + "example": "attribute:Background" }, - "collection_name": { + "values": { + "type": "array", + "description": "The metadata field values to match against (OR semantics)", + "items": { + "type": "string" + }, + "minItems": 1, + "example": [ + "Blue", + "Red" + ] + } + }, + "required": [ + "field_name", + "values" + ] + }, + "CreateMetadataBidRequestBody": { + "type": "object", + "description": "Request body for creating a metadata bid. Exactly one of `metadata_id`\nor `metadata_criteria` must be provided.\n", + "properties": { + "account_address": { "type": "string", - "description": "NFT Collection name" + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "collection_image": { + "order_hash": { "type": "string", - "description": "NFT Collection image" + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" }, - "asset_image": { + "metadata_id": { "type": "string", - "description": "NFT Asset name" + "format": "uuid", + "description": "Metadata identifier that matching NFTs must have to fulfill this bid. Mutually exclusive with `metadata_criteria`.", + "example": "018792C9-4AD7-8EC4-4038-9E05C598534B" }, - "asset_name": { - "type": "string", - "description": "NFT Asset image" + "metadata_criteria": { + "type": "array", + "description": "Field-level metadata filters that matching NFTs must satisfy to fulfill this bid. Mutually exclusive with `metadata_id`.", + "items": { + "$ref": "#/components/schemas/MetadataFieldFilter" + }, + "minItems": 1, + "example": [ + { + "field_name": "name", + "values": [ + "Cool Dragon" + ] + }, + { + "field_name": "attribute:Background", + "values": [ + "Blue", + "Red" + ] + } + ] }, - "is_smart_contract": { - "type": "boolean", - "description": "Indicate if it is a Smart Contract or EOA" + "buy": { + "type": "array", + "description": "Buy item for metadata bid should either be ERC721 or ERC1155 collection item", + "items": { + "$ref": "#/components/schemas/AssetCollectionItem" + }, + "example": [ + { + "type": "ERC721_COLLECTION", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "amount": "1" + } + ], + "minItems": 1, + "maxItems": 1 }, - "is_contract_verified": { - "type": "boolean", - "description": "Is Contract Verified" + "fees": { + "type": "array", + "description": "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.", + "items": { + "$ref": "#/components/schemas/Fee" + }, + "example": [], + "minItems": 0, + "maxItems": 2 }, - "contract_name": { + "end_at": { "type": "string", - "description": "Smart Contract Name" + "description": "Time after which the Order is considered expired", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" }, - "token_id": { + "protocol_data": { + "$ref": "#/components/schemas/ProtocolData" + }, + "salt": { "type": "string", - "description": "ID of the ERC721", - "example": "1" + "description": "A random value added to the create Order request", + "example": "12686911856931635052326433555881236148" }, - "immutable_verification_status": { - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "sell": { + "type": "array", + "description": "Sell item for metadata bid should be an ERC20 item", + "items": { + "$ref": "#/components/schemas/ERC20Item" + }, + "example": [ + { + "type": "ERC20", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "amount": "9750000000000000000" + } + ], + "minItems": 1, + "maxItems": 1 + }, + "signature": { + "type": "string", + "description": "Digital signature generated by the user for the specific Order", + "example": "0x" + }, + "start_at": { + "type": "string", + "description": "Time after which Order is considered active", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" } - } + }, + "example": { + "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" + }, + "required": [ + "account_address", + "order_hash", + "buy", + "sell", + "fees", + "end_at", + "start_at", + "protocol_data", + "salt", + "signature" + ] }, - "ERC20TransferMetadata": { + "CreateTraitBidRequestBody": { "type": "object", - "required": [ - "transaction_type", - "to_address", - "amount", - "decimals", - "symbol", - "immutable_verification_status", - "image_url" - ], "properties": { - "transaction_type": { - "type": "string", - "description": "Transaction type", - "enum": [ - "ERC20_TRANSFER" - ] - }, - "to_address": { + "account_address": { "type": "string", - "description": "The address to transfer the token to", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "amount": { + "order_hash": { "type": "string", - "description": "A string representing the amount of tokens to transfer", - "example": "10000000000000000" + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266" }, - "immutable_verification_status": { - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "buy": { + "type": "array", + "description": "Buy item for trait bid should either be ERC721 or ERC1155 collection item", + "items": { + "$ref": "#/components/schemas/AssetCollectionItem" + }, + "example": [ + { + "type": "ERC721_COLLECTION", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "amount": "1" + } + ], + "minItems": 1, + "maxItems": 1 }, - "decimals": { - "type": "integer", - "description": "The token decimals", - "example": 18 + "fees": { + "type": "array", + "description": "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.", + "items": { + "$ref": "#/components/schemas/Fee" + }, + "example": [], + "minItems": 0, + "maxItems": 2 }, - "symbol": { + "end_at": { "type": "string", - "description": "The symbol of the token being transferred", - "example": "AAA" + "description": "Time after which the Order is considered expired", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" }, - "image_url": { - "type": "string", - "description": "The image of the token being transferred", - "example": "https://some-url" - } - } - }, - "ERC20TransferFromMetadata": { - "type": "object", - "required": [ - "transaction_type", - "immutable_verification_status", - "from_address", - "to_address", - "amount", - "decimals", - "symbol", - "image_url" - ], - "properties": { - "transaction_type": { - "type": "string", - "description": "Transaction type", - "enum": [ - "ERC20_TRANSFER_FROM" - ] + "protocol_data": { + "$ref": "#/components/schemas/ProtocolData" }, - "from_address": { + "salt": { "type": "string", - "description": "The address to transfer the token from", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + "description": "A random value added to the create Order request", + "example": "12686911856931635052326433555881236148" }, - "to_address": { - "type": "string", - "description": "The address to transfer the token to", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + "sell": { + "type": "array", + "description": "Sell item for trait bid should be an ERC20 item", + "items": { + "$ref": "#/components/schemas/ERC20Item" + }, + "example": [ + { + "type": "ERC20", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "amount": "9750000000000000000" + } + ], + "minItems": 1, + "maxItems": 1 }, - "amount": { + "signature": { "type": "string", - "description": "A string representing the amount of tokens to transfer", - "example": "10000000000000000" - }, - "immutable_verification_status": { - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" - }, - "decimals": { - "type": "integer", - "description": "The token decimals", - "example": 18 + "description": "Digital signature generated by the user for the specific Order", + "example": "0x" }, - "symbol": { + "start_at": { "type": "string", - "description": "The symbol of the token being transferred", - "example": "AAA" + "description": "Time after which Order is considered active", + "format": "date-time", + "example": "2022-03-09T05:00:50.52Z" }, - "image_url": { - "type": "string", - "description": "The image of the token being transferred", - "example": "https://some-url" + "trait_criteria": { + "type": "array", + "description": "Trait criteria to match NFTs against", + "items": { + "$ref": "#/components/schemas/TraitFilter" + }, + "minItems": 1, + "example": [ + { + "trait_type": "Background", + "values": [ + "Blue", + "Red" + ] + } + ] + } + }, + "example": { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "order_hash": "0x0821933d9391bc9bf11a6010fe84776c84b203abff0c1ad781fb4881409c8770", + "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", + "trait_criteria": [ + { + "trait_type": "Background", + "values": [ + "Blue", + "Red" + ] + } + ] + }, + "required": [ + "account_address", + "order_hash", + "buy", + "sell", + "fees", + "end_at", + "start_at", + "protocol_data", + "salt", + "signature", + "trait_criteria" + ] + }, + "TraitBidResult": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/Order" + } + }, + "required": [ + "result" + ], + "example": { + "result": { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "sell": [ + { + "type": "ERC20", + "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", + "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": "TRAIT_BID", + "updated_at": "2022-03-07T07:20:50.52Z" } } }, - "ERC20ApproveMetadata": { + "ListTraitBidsResult": { "type": "object", - "required": [ - "transaction_type", - "amount", - "token_symbol", - "spender", - "is_smart_contract", - "is_contract_verified", - "immutable_verification_status", - "contract_name", - "image_url" - ], "properties": { - "transaction_type": { - "type": "string", - "description": "Transaction type", - "enum": [ - "ERC20_APPROVE" - ] - }, - "immutable_verification_status": { - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" - }, - "amount": { - "type": "string", - "description": "Requested approval amount" - }, - "token_symbol": { - "type": "string", - "description": "Requested token symbol" - }, - "spender": { - "type": "string", - "description": "Spender address" - }, - "is_smart_contract": { - "type": "boolean", - "description": "Indicate if it is a Smart Contract or EOA" - }, - "is_contract_verified": { - "type": "boolean", - "description": "Is Contract Verified" - }, - "contract_name": { - "type": "string", - "description": "Smart Contract Name" + "page": { + "$ref": "#/components/schemas/Page" }, - "image_url": { - "type": "string", - "example": "https://example.com/erc20.jpg" + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + }, + "minItems": 0, + "maxItems": 200 } - } + }, + "required": [ + "page", + "result" + ] }, - "NFTSetApprovalForAllMetadata": { + "ListMetadataBidsResult": { "type": "object", - "required": [ - "transaction_type", - "collection_name", - "collection_image", - "is_smart_contract", - "is_contract_verified", - "contract_name", - "immutable_verification_status" - ], "properties": { - "transaction_type": { - "type": "string", - "description": "Transaction type", - "enum": [ - "ERC721_SET_APPROVAL_FOR_ALL", - "ERC1155_SET_APPROVAL_FOR_ALL" - ] - }, - "collection_name": { - "type": "string", - "description": "NFT Collection name" - }, - "collection_image": { - "type": "string", - "description": "NFT Collection image" - }, - "is_smart_contract": { - "type": "boolean", - "description": "Indicate if it is a Smart Contract or EOA" - }, - "is_contract_verified": { - "type": "boolean", - "description": "Is Contract Verified" - }, - "contract_name": { - "type": "string", - "description": "Smart Contract Name" + "page": { + "$ref": "#/components/schemas/Page" }, - "immutable_verification_status": { - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + }, + "minItems": 0, + "maxItems": 200 } - } + }, + "required": [ + "page", + "result" + ] }, - "ERC721TransferFromMetadata": { + "ListListingsResult": { "type": "object", - "required": [ - "transaction_type", - "from_address", - "to_address", - "collection_name", - "token_id", - "asset_name", - "asset_image", - "immutable_verification_status" - ], "properties": { - "transaction_type": { - "type": "string", - "description": "Transaction type", - "enum": [ - "ERC721_TRANSFER_FROM" - ] - }, - "from_address": { - "type": "string", - "description": "The address to transfer the token from", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - }, - "to_address": { - "type": "string", - "description": "The address to transfer the token to", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - }, - "collection_name": { - "type": "string", - "description": "The collection name the ERC721 belongs to" - }, - "token_id": { - "type": "string", - "description": "ID of the ERC721", - "example": "1" - }, - "asset_name": { - "type": "string", - "description": "The name of the ERC721", - "example": "Sword" - }, - "asset_image": { - "type": "string", - "description": "The image of the ERC721", - "example": "https://some-url" + "page": { + "$ref": "#/components/schemas/Page" }, - "immutable_verification_status": { - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + }, + "minItems": 0, + "maxItems": 200 } + }, + "required": [ + "page", + "result" + ], + "example": { + "page": { + "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA", + "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA" + }, + "result": [ + { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "buy": [ + { + "type": "ERC20", + "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", + "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "protocol_data": { + "order_type": "FULL_RESTRICTED", + "counter": "1", + "zone_address": "0x12", + "seaport_address": "0x12", + "seaport_version": "1.5" + }, + "salt": "12686911856931635052326433555881236148", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z", + "status": { + "name": "EXPIRED" + }, + "updated_at": "2022-03-07T07:20:50.52Z" + }, + { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "buy": [ + { + "type": "ERC20", + "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", + "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "protocol_data": { + "order_type": "FULL_RESTRICTED", + "counter": "1", + "zone_address": "0x12", + "seaport_address": "0x12", + "seaport_version": "1.5" + }, + "salt": "12686911856931635052326433555881236148", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z", + "status": { + "name": "EXPIRED" + }, + "updated_at": "2022-03-07T07:20:50.52Z" + } + ] } }, - "ERC721SafeTransferFromBatchMetadata": { + "ListBidsResult": { "type": "object", - "required": [ - "transaction_type", - "from_address", - "collection_name", - "items", - "immutable_verification_status" - ], "properties": { - "transaction_type": { - "type": "string", - "description": "Transaction type", - "enum": [ - "ERC721_SAFE_TRANSFER_FROM_BATCH" - ] - }, - "from_address": { - "type": "string", - "description": "The address to transfer the token from", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - }, - "collection_name": { - "type": "string", - "description": "The collection name the ERC721 belongs to", - "example": "Guild of Guardians Heroes" + "page": { + "$ref": "#/components/schemas/Page" }, - "items": { + "result": { "type": "array", - "description": "The ERC721s to transfer and where to transfer them to", "items": { - "$ref": "#/components/schemas/ERC721SafeTransferFromBatchItem" - } - }, - "immutable_verification_status": { - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "$ref": "#/components/schemas/Order" + }, + "minItems": 0, + "maxItems": 200 } + }, + "required": [ + "page", + "result" + ], + "example": { + "page": { + "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA", + "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA" + }, + "result": [ + { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "sell": [ + { + "type": "ERC20", + "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", + "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "protocol_data": { + "order_type": "FULL_RESTRICTED", + "counter": "1", + "zone_address": "0x12", + "seaport_address": "0x12", + "seaport_version": "1.5" + }, + "salt": "12686911856931635052326433555881236148", + "buy": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z", + "status": { + "name": "EXPIRED" + }, + "updated_at": "2022-03-07T07:20:50.52Z" + }, + { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "sell": [ + { + "type": "ERC20", + "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", + "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "protocol_data": { + "order_type": "FULL_RESTRICTED", + "counter": "1", + "zone_address": "0x12", + "seaport_address": "0x12", + "seaport_version": "1.5" + }, + "salt": "12686911856931635052326433555881236148", + "buy": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "signature": "0x", + "start_at": "2022-03-09T05:00:50.52Z", + "status": { + "name": "EXPIRED" + }, + "updated_at": "2022-03-07T07:20:50.52Z" + } + ] } }, - "ERC721SafeTransferFromBatchItem": { + "ListCollectionBidsResult": { "type": "object", - "required": [ - "to_address", - "token_id", - "asset_name", - "asset_image" - ], "properties": { - "to_address": { - "type": "string", - "description": "The address to transfer the token to", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - }, - "token_id": { - "type": "string", - "description": "ID of the ERC721", - "example": "1" - }, - "asset_name": { - "type": "string", - "description": "The name of the ERC721", - "example": "Sword" + "page": { + "$ref": "#/components/schemas/Page" }, - "asset_image": { - "type": "string", - "description": "The image of the ERC721", - "example": "https://some-url" + "result": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + }, + "minItems": 0, + "maxItems": 200 } + }, + "required": [ + "page", + "result" + ], + "example": { + "page": { + "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA", + "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA" + }, + "result": [ + { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "sell": [ + { + "type": "ERC20", + "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", + "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" + }, + "updated_at": "2022-03-07T07:20:50.52Z" + }, + { + "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", + "sell": [ + { + "type": "ERC20", + "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", + "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" + }, + "updated_at": "2022-03-07T07:20:50.52Z" + } + ] } }, - "UnknownMetadata": { + "TradeResult": { "type": "object", - "required": [ - "transaction_type", - "is_smart_contract", - "is_contract_verified", - "contract_name" - ], "properties": { - "transaction_type": { - "type": "string", - "description": "Transaction type", - "enum": [ - "UNKNOWN" - ] - }, - "is_smart_contract": { - "type": "boolean", - "description": "Indicate if it is a Smart Contract or EOA" - }, - "is_contract_verified": { - "type": "boolean", - "description": "Is Contract Verified" - }, - "contract_name": { - "type": "string", - "description": "Smart Contract Name" + "result": { + "$ref": "#/components/schemas/Trade" } - } - }, - "UnknownTypedDataMetadata": { - "type": "object", + }, "required": [ - "typed_data_type" + "result" ], - "properties": { - "typed_data_type": { - "type": "string", - "description": "Unknown typed data type", - "enum": [ - "UNKNOWN" - ] + "example": { + "result": { + "buy": [ + { + "type": "ERC20", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "buyer_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", + "buyer_fees": [], + "chain": { + "id": "eip155:11155111", + "name": "sepolia" + }, + "created_at": "2022-03-07T07:20:50.52Z", + "id": "018792C9-4AD7-8EC4-4038-9E05C598534B", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "seller_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", + "maker_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", + "taker_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", + "updated_at": "2022-03-07T07:20:50.52Z" } } }, - "SeaportFulfillAvailableAdvancedOrdersMetadata": { + "ListTradeResult": { "type": "object", - "required": [ - "transaction_type", - "is_smart_contract", - "is_contract_verified", - "contract_name", - "buy", - "sell", - "fees" - ], "properties": { - "transaction_type": { - "type": "string", - "description": "Transaction type", - "enum": [ - "SEAPORT_FULFILL_AVAILABLE_ADVANCED_ORDERS" - ] - }, - "is_smart_contract": { - "type": "boolean", - "description": "Indicate if it is a Smart Contract or EOA" - }, - "is_contract_verified": { - "type": "boolean", - "description": "Is Contract Verified" - }, - "contract_name": { - "type": "string", - "description": "Smart Contract Name" + "page": { + "$ref": "#/components/schemas/Page" }, - "orders": { + "result": { "type": "array", "items": { - "$ref": "#/components/schemas/SeaportAdvancedOrder" - } + "$ref": "#/components/schemas/Trade" + }, + "minItems": 0, + "maxItems": 200 } - } - }, - "SeaportAdvancedOrder": { - "type": "object", - "properties": { - "buy": { - "oneOf": [ - { - "$ref": "#/components/schemas/SeaportNativeItem" - }, - { - "$ref": "#/components/schemas/SeaportERC20Item" - }, - { - "$ref": "#/components/schemas/SeaportERC1155Item" - }, - { - "$ref": "#/components/schemas/SeaportERC1155CollectionItem" - }, - { - "$ref": "#/components/schemas/SeaportERC721Item" - }, - { - "$ref": "#/components/schemas/SeaportERC721CollectionItem" - } - ], - "example": [ - { - "type": "NATIVE", - "amount": "10000000000000000", - "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" - } - ] + }, + "required": [ + "page", + "result" + ], + "example": { + "page": { + "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA", + "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA" }, - "sell": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/SeaportERC1155Item" - }, - { - "$ref": "#/components/schemas/SeaportERC721Item" + "result": [ + { + "buy": [ + { + "type": "ERC20", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "buyer_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", + "buyer_fees": [], + "chain": { + "id": "eip155:11155111", + "name": "sepolia" }, - { - "$ref": "#/components/schemas/SeaportNativeItem" + "created_at": "2022-03-07T07:20:50.52Z", + "id": "018792C9-4AD7-8EC4-4038-9E05C598534A", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "seller_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", + "maker_address": "0x002b9B1cbf464782Df5d48870358FA6c09f1b19D", + "taker_address": "0xFC99a706C0D05B8C71E1fAAC91b3E1343aC34D40", + "updated_at": "2022-03-07T07:20:50.52Z" + }, + { + "buy": [ + { + "type": "ERC20", + "amount": "9750000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ], + "buyer_address": "0x017406f3F27d507a1491976B7835CE5CD0fA647a", + "buyer_fees": [], + "chain": { + "id": "eip155:11155111", + "name": "sepolia" }, - { - "$ref": "#/components/schemas/SeaportERC20Item" - } - ] + "created_at": "2022-03-07T07:20:50.52Z", + "id": "018792C9-4AD7-8EC4-4038-9E05C598534A", + "sell": [ + { + "type": "ERC721", + "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "token_id": "1" + } + ], + "seller_address": "0xC73349c545C1D757eb650cDc463A2f6dF1Ec41cb", + "maker_address": "0xC73349c545C1D757eb650cDc463A2f6dF1Ec41cb", + "taker_address": "0x017406f3F27d507a1491976B7835CE5CD0fA647a", + "updated_at": "2022-03-07T07:20:50.52Z" + } + ] + } + }, + "OrderStatus": { + "description": "The Order status", + "oneOf": [ + { + "$ref": "#/components/schemas/CancelledOrderStatus" }, - "fees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeaportFee" - }, - "example": [], - "minItems": 0 + { + "$ref": "#/components/schemas/PendingOrderStatus" + }, + { + "$ref": "#/components/schemas/ActiveOrderStatus" + }, + { + "$ref": "#/components/schemas/InactiveOrderStatus" + }, + { + "$ref": "#/components/schemas/FilledOrderStatus" + }, + { + "$ref": "#/components/schemas/ExpiredOrderStatus" } - }, - "required": [ - "buy", - "sell", - "fees" - ] + ], + "discriminator": { + "propertyName": "name", + "mapping": { + "CANCELLED": "#/components/schemas/CancelledOrderStatus", + "PENDING": "#/components/schemas/PendingOrderStatus", + "ACTIVE": "#/components/schemas/ActiveOrderStatus", + "INACTIVE": "#/components/schemas/InactiveOrderStatus", + "FILLED": "#/components/schemas/FilledOrderStatus", + "EXPIRED": "#/components/schemas/ExpiredOrderStatus" + } + } }, - "SeaportNativeItem": { + "CancelledOrderStatus": { "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Token type user is offering, which in this case is the native IMX token", - "example": "NATIVE", + "description": "The order status indicating a order is has been cancelled or about to be cancelled.", "enum": [ - "NATIVE" + "CANCELLED" ] }, - "amount": { - "type": "string", - "description": "A string representing the price at which the user is willing to sell the token", - "example": "10000000000000000" + "pending": { + "type": "boolean", + "description": "Whether the cancellation of the order is pending", + "example": false }, - "decimals": { - "type": "integer", - "description": "The decimal of this item", - "example": 18 + "cancellation_type": { + "type": "string", + "description": "Whether the cancellation was done on-chain or off-chain or as a result of an underfunded account", + "enum": [ + "ON_CHAIN", + "OFF_CHAIN", + "UNDERFUNDED" + ], + "example": "ON_CHAIN" } }, "required": [ - "type", - "amount", - "decimals" + "name", + "pending", + "cancellation_type" ] }, - "SeaportERC20Item": { + "PendingOrderStatus": { "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Token type user is offering, which in this case is ERC20", - "example": "ERC20", + "description": "The order status that indicates the order is yet to be active due to various reasons.", "enum": [ - "ERC20" + "PENDING" ] }, - "contract_address": { - "type": "string", - "description": "Address of ERC20 token", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, - "symbol": { - "type": "string", - "description": "The symbol of token", - "example": "AAA", - "nullable": true - }, - "image_url": { - "type": "string", - "description": "The image url of token", - "example": "https://some-url", - "nullable": true - }, - "amount": { - "type": "string", - "description": "A string representing the price at which the user is willing to sell the token", - "example": "10000000000000000" - }, - "decimals": { - "type": "integer", - "description": "The decimal of this erc20 item", - "example": 18 + "evaluated": { + "type": "boolean", + "description": "Whether the order has been evaluated after its creation", + "example": false }, - "immutable_verification_status": { - "type": "string", - "description": "The Immutable verification status of this collection", - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "started": { + "type": "boolean", + "description": "Whether the order has reached its specified start time", + "example": false } }, "required": [ - "type", - "contract_address", - "amount", - "decimals", - "immutable_verification_status" + "name", + "evaluated", + "started" ] }, - "SeaportERC721Item": { + "ActiveOrderStatus": { "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Token type user is offering, which in this case is ERC721", - "example": "ERC721", + "description": "The order status that indicates an order can be fulfilled.", "enum": [ - "ERC721" + "ACTIVE" ] - }, - "contract_address": { - "type": "string", - "description": "Address of ERC721 token", - "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, - "contract_name": { - "type": "string", - "nullable": true, - "description": "The name of the collection", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - "image_url": { - "type": "string", - "description": "The URL of the NFT", - "example": "https://example.com/nft.jpeg" - }, - "name": { - "type": "string", - "nullable": true, - "example": "Sword", - "description": "The name of the NFT" - }, - "token_id": { - "type": "string", - "description": "ID of ERC721 token", - "example": "1", - "pattern": "\\d+" - }, - "immutable_verification_status": { - "type": "string", - "description": "The Immutable verification status of this collection", - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } }, - "example": [ - { - "type": "ERC721", - "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", - "contract_name": "Guild of Guardians Heroes", - "name": "Bestowing Saint", - "token_id": "1", - "immutable_verification_status": "verified" - } - ], "required": [ - "type", - "contract_address", - "token_id", - "immutable_verification_status" + "name" ] }, - "SeaportERC1155Item": { + "InactiveOrderStatus": { "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Token type user is offering, which in this case is ERC1155", - "example": "ERC1155", + "description": "The order status that indicates an order cannot be fulfilled.", "enum": [ - "ERC1155" + "INACTIVE" ] }, - "contract_address": { - "type": "string", - "description": "Address of ERC1155 token", - "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, - "contract_name": { - "type": "string", - "nullable": true, - "description": "The name of the collection", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - "image_url": { - "type": "string", - "description": "The URL of the asset", - "example": "https://example.com/nft.jpeg" - }, - "name": { - "type": "string", - "nullable": true, - "example": "Sword", - "description": "The name of the asset" - }, - "token_id": { - "type": "string", - "description": "ID of ERC1155 token", - "example": "1", - "pattern": "\\d+" - }, - "amount": { - "type": "string", - "description": "A string representing the total units of an ERC1155 token which the user is buying/selling", - "example": "100" + "sufficient_approvals": { + "type": "boolean", + "description": "Whether the order offerer has sufficient approvals", + "example": false }, - "immutable_verification_status": { + "sufficient_balances": { + "type": "boolean", + "description": "Whether the order offerer still has sufficient balance to complete the order", + "example": false + } + }, + "required": [ + "name", + "sufficient_approvals", + "sufficient_balances" + ] + }, + "ExpiredOrderStatus": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "The Immutable verification status of this collection", - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "description": "A terminal order status indicating that an order cannot be fulfilled due to expiry.", + "enum": [ + "EXPIRED" + ] } }, - "example": [ - { - "type": "ERC1155", - "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", - "contract_name": "Guild of Guardians Heroes", - "name": "Bestowing Saint", - "token_id": "1", - "amount": "100", - "immutable_verification_status": "verified" - } - ], "required": [ - "type", - "contract_address", - "token_id", - "amount", - "immutable_verification_status" + "name" ] }, - "SeaportERC721CollectionItem": { + "FilledOrderStatus": { "type": "object", "properties": { - "type": { + "name": { "type": "string", - "description": "Token type user is offering, which in this case is ERC721Collection", - "example": "ERC721Collection", + "description": "A terminal order status indicating that an order has been fulfilled.", "enum": [ - "ERC721Collection" + "FILLED" ] - }, - "contract_address": { + } + }, + "required": [ + "name" + ] + }, + "OrderStatusName": { + "type": "string", + "description": "The Order status", + "enum": [ + "PENDING", + "ACTIVE", + "INACTIVE", + "FILLED", + "EXPIRED", + "CANCELLED" + ] + }, + "ProtocolData": { + "type": "object", + "properties": { + "order_type": { "type": "string", - "description": "Address of ERC721 token", - "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "pattern": "^0x[a-fA-F0-9]{40}$" + "description": "Seaport order type. Orders containing ERC721 tokens will need to pass in the order type as FULL_RESTRICTED while orders with ERC1155 tokens will need to pass in the order_type as PARTIAL_RESTRICTED", + "example": "FULL_RESTRICTED", + "enum": [ + "FULL_RESTRICTED", + "PARTIAL_RESTRICTED" + ] }, - "contract_name": { + "counter": { "type": "string", - "nullable": true, - "description": "The name of the collection", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" + "description": "big.Int or uint256 string for order counter", + "example": "92315562" }, - "image_url": { + "zone_address": { "type": "string", - "description": "The URL of the collection image", - "example": "https://example.com/nft.jpeg" + "description": "Immutable zone address", + "example": "0x12" }, - "amount": { + "seaport_address": { "type": "string", - "description": "A string representing the total units of an ERC721 token which the user is buying", - "example": "10" + "description": "Immutable Seaport contract address", + "example": "0x12" }, - "immutable_verification_status": { + "seaport_version": { "type": "string", - "description": "The Immutable verification status of this collection", - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "description": "Immutable Seaport contract version", + "example": "1.5" } }, - "example": [ - { - "type": "ERC721Collection", - "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", - "amount": "10", - "immutable_verification_status": "verified" - } - ], + "example": { + "order_type": "FULL_RESTRICTED", + "counter": "92315562", + "zone_address": "0x12", + "seaport_address": "0x12", + "seaport_version": "1.5" + }, "required": [ - "type", - "contract_address", - "image_url", - "amount", - "immutable_verification_status" + "order_type", + "counter", + "zone_address", + "seaport_address", + "seaport_version" ] }, - "SeaportERC1155CollectionItem": { + "TradeBlockchainMetadata": { + "description": "The metadata related to the transaction in which the activity occurred", + "nullable": true, "type": "object", "properties": { - "type": { + "transaction_hash": { "type": "string", - "description": "Token type user is offering, which in this case is ERC1155Collection", - "example": "ERC1155Collection", - "enum": [ - "ERC1155Collection" - ] + "description": "The transaction hash of the trade", + "example": "0x68d9eac5e3b3c3580404989a4030c948a78e1b07b2b5ea5688d8c38a6c61c93e" }, - "contract_address": { + "block_number": { + "description": "EVM block number (uint64 as string)", "type": "string", - "description": "Address of ERC1155 token", - "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", - "pattern": "^0x[a-fA-F0-9]{40}$" + "example": "1" }, - "image_url": { + "transaction_index": { + "description": "Transaction index in a block (uint32 as string)", "type": "string", - "description": "The URL of the collection image", - "example": "https://example.com/nft.jpeg" + "example": "1" }, - "contract_name": { + "log_index": { + "description": "The log index of the fulfillment event in a block (uint32 as string)", "type": "string", - "nullable": true, - "description": "The name of the collection", - "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" - }, - "amount": { + "example": "1" + } + }, + "required": [ + "transaction_hash", + "block_number", + "transaction_index", + "log_index" + ] + }, + "FillStatus": { + "description": "The ratio of the order that has been filled, an order that has been fully filled will have the same numerator and denominator values.", + "type": "object", + "properties": { + "numerator": { "type": "string", - "description": "A string representing the total units of an ERC1155 token which the user is buying", - "example": "100" + "description": "The numerator of the fill status", + "example": "1" }, - "immutable_verification_status": { + "denominator": { "type": "string", - "description": "The Immutable verification status of this collection", - "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + "description": "The denominator of the fill status", + "example": "2" } }, - "example": [ + "required": [ + "numerator", + "denominator" + ] + }, + "APIError501": { + "allOf": [ { - "type": "ERC1155", - "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", - "contract_name": "Guild of Guardians Heroes", - "amount": "100", - "immutable_verification_status": "verified" + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "NOT_IMPLEMENTED_ERROR" + ], + "example": "NOT_IMPLEMENTED_ERROR" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" + } + }, + "required": [ + "code", + "details" + ] + } + ] + }, + "APIError503": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "SERVICE_UNAVAILABLE" + ], + "example": "SERVICE_UNAVAILABLE" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" + } + }, + "required": [ + "code", + "details" + ] + } + ] + }, + "APIError504": { + "allOf": [ + { + "$ref": "#/components/schemas/BasicAPIError" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "enum": [ + "GATEWAY_TIMEOUT" + ], + "example": "GATEWAY_TIMEOUT" + }, + "details": { + "type": "object", + "nullable": true, + "description": "Additional details to help resolve the error" + } + }, + "required": [ + "code", + "details" + ] } - ], - "required": [ - "type", - "image_url", - "contract_address", - "amount", - "immutable_verification_status" ] }, - "SeaportFee": { + "CreateCounterfactualAddressRequest": { "type": "object", + "required": [ + "ethereum_address", + "ethereum_signature" + ], "properties": { - "type": { - "type": "string", - "description": "Token type of the Fee", - "example": "ERC20", - "enum": [ - "ERC20", - "NATIVE" - ] - }, - "amount": { + "ethereum_address": { + "description": "The user's UAK address", "type": "string", - "description": "Fee payable to recipient upon settlement", - "example": "10000000000000000" + "maxLength": 42 }, - "recipient_address": { + "ethereum_signature": { + "description": "The signature generated with the UAK", "type": "string", - "description": "Wallet address of fee recipient", - "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233", - "pattern": "^0x[a-fA-F0-9]{40}$" - }, + "maxLength": 132 + } + }, + "additionalProperties": false + }, + "GetTransactionMetadataRequest": { + "type": "object", + "required": [ + "contract_address", + "method_id", + "transaction_id", + "transaction_data" + ], + "properties": { "contract_address": { + "description": "The address of the contract intended for interaction with this transaction", "type": "string", - "description": "Address of the ERC20 token for the fee", - "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F", - "pattern": "^0x[a-fA-F0-9]{40}$" + "pattern": "^0x[0-9a-fA-F]*$", + "maxLength": 42 }, - "symbol": { + "method_id": { + "description": "The method ID of the contract intended for interaction with this transaction", "type": "string", - "description": "The symbol of token for the fee", - "example": "AAA", - "nullable": true + "maxLength": 132 }, - "decimals": { - "type": "integer", - "description": "The decimal of this item", - "example": 18 + "transaction_id": { + "description": "ID of the given transaction to be decoded", + "type": "string" + }, + "transaction_data": { + "description": "Encoded transaction data", + "pattern": "^0x[0-9a-fA-F]*$", + "type": "string" } }, - "example": { - "amount": "10000000000000000", - "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233", - "type": "NATIVE" - }, - "required": [ - "amount", - "type", - "recipient_address", - "decimals" - ] + "additionalProperties": false }, - "SeaportCreateListingMetadata": { + "CreateCounterfactualAddressRes": { "type": "object", "required": [ - "typed_data_type", - "buy", - "sell", - "fees" + "counterfactual_address" ], "properties": { - "typed_data_type": { + "counterfactual_address": { + "description": "The user's counterfactual address", "type": "string", - "description": "Typed data type", - "enum": [ - "SEAPORT_CREATE_LISTING_METADATA" - ] - }, - "buy": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/SeaportNativeItem" - }, - { - "$ref": "#/components/schemas/SeaportERC20Item" - }, - { - "$ref": "#/components/schemas/SeaportERC721Item" - }, - { - "$ref": "#/components/schemas/SeaportERC721CollectionItem" - }, - { - "$ref": "#/components/schemas/SeaportERC1155Item" - }, - { - "$ref": "#/components/schemas/SeaportERC1155CollectionItem" - } - ], - "example": [ - { - "type": "ERC721", - "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", - "contract_name": "Guild of Guardians Heroes", - "name": "Bestowing Saint", - "token_id": 1 - } - ] - }, - "sell": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/SeaportNativeItem" - }, - { - "$ref": "#/components/schemas/SeaportERC20Item" - }, - { - "$ref": "#/components/schemas/SeaportERC721Item" - }, - { - "$ref": "#/components/schemas/SeaportERC1155Item" - } - ] - }, - "fees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeaportFee" - } + "maxLength": 42 } } }, - "GetTransactionMetadataRes": { + "GetLinkedAddressesResDeprecated": { "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/ERC20ApproveMetadata" - }, - { - "$ref": "#/components/schemas/ERC20TransferMetadata" - }, - { - "$ref": "#/components/schemas/ERC20TransferFromMetadata" - }, - { - "$ref": "#/components/schemas/ERC721ApproveMetadata" - }, - { - "$ref": "#/components/schemas/NFTSetApprovalForAllMetadata" - }, - { - "$ref": "#/components/schemas/ERC721TransferFromMetadata" - }, - { - "$ref": "#/components/schemas/ERC721SafeTransferFromBatchMetadata" - }, - { - "$ref": "#/components/schemas/SeaportFulfillAvailableAdvancedOrdersMetadata" - }, - { - "$ref": "#/components/schemas/UnknownMetadata" + "required": [ + "linkedAddresses" + ], + "properties": { + "linkedAddresses": { + "type": "array", + "minItems": 0, + "description": "The user's list of linked addresses", + "items": { + "description": "The user's linked address", + "type": "string", + "pattern": "^0x[0-9a-fA-F]*$", + "maxLength": 42 + } } - ] + } }, - "GetTypedDataMetadataRes": { + "GetPassportMetadataRes": { "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/SeaportCreateListingMetadata" - }, - { - "$ref": "#/components/schemas/UnknownTypedDataMetadata" + "required": [ + "passport_metadata" + ], + "properties": { + "passport_metadata": { + "type": "array", + "minItems": 0, + "description": "The user's passport metadata", + "items": { + "description": "The user's passport metadata", + "type": "object", + "properties": { + "chain_id": { + "type": "string", + "description": "The chain id (eg: eip155:1)" + }, + "chain_key": { + "type": "string", + "description": "The chain key" + }, + "user_admin_key": { + "type": "string", + "description": "The user admin key" + }, + "counterfactual_address": { + "type": "string", + "description": "The counterfactual address" + } + } + } } - ] + } }, - "GetTypedDataMetadataRequest": { + "GetLinkedAddressesRes": { "type": "object", "required": [ - "payload" + "linked_addresses" ], "properties": { - "payload": { - "$ref": "#/components/schemas/EIP712Message" + "linked_addresses": { + "type": "array", + "minItems": 0, + "description": "The user's list of linked addresses", + "items": { + "description": "The user's linked address", + "type": "string", + "pattern": "^0x[0-9a-fA-F]*$", + "maxLength": 42 + } } } }, - "GetWalletUserRes": { + "ImmutableVerificationStatusEnum": { + "type": "string", + "enum": [ + "verified", + "unverified", + "spam", + "inactive" + ] + }, + "ERC721ApproveMetadata": { "type": "object", "required": [ - "email", - "user_id" + "transaction_type", + "collection_name", + "collection_image", + "asset_image", + "asset_name", + "is_smart_contract", + "is_contract_verified", + "contract_name", + "token_id", + "immutable_verification_status" ], "properties": { - "user_id": { + "transaction_type": { "type": "string", - "description": "The user id associated with the wallet address", - "example": "google|1234" + "description": "Transaction type", + "enum": [ + "ERC721_APPROVE" + ] }, - "email": { + "collection_name": { + "type": "string", + "description": "NFT Collection name" + }, + "collection_image": { + "type": "string", + "description": "NFT Collection image" + }, + "asset_image": { + "type": "string", + "description": "NFT Asset name" + }, + "asset_name": { + "type": "string", + "description": "NFT Asset image" + }, + "is_smart_contract": { + "type": "boolean", + "description": "Indicate if it is a Smart Contract or EOA" + }, + "is_contract_verified": { + "type": "boolean", + "description": "Is Contract Verified" + }, + "contract_name": { + "type": "string", + "description": "Smart Contract Name" + }, + "token_id": { "type": "string", - "description": "The email address associated with the wallet address", - "example": "user@example.com" + "description": "ID of the ERC721", + "example": "1" + }, + "immutable_verification_status": { + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } } }, - "GetUserWalletRes": { + "ERC20TransferMetadata": { "type": "object", "required": [ - "wallet_address" + "transaction_type", + "to_address", + "amount", + "decimals", + "symbol", + "immutable_verification_status", + "image_url" ], "properties": { - "wallet_address": { + "transaction_type": { + "type": "string", + "description": "Transaction type", + "enum": [ + "ERC20_TRANSFER" + ] + }, + "to_address": { + "type": "string", + "description": "The address to transfer the token to", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + }, + "amount": { "type": "string", - "description": "The wallet address associated with the user", - "pattern": "^0x[0-9a-fA-F]{40}$", - "example": "0x1234567890abcdef1234567890abcdef12345678" + "description": "A string representing the amount of tokens to transfer", + "example": "10000000000000000" + }, + "immutable_verification_status": { + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + }, + "decimals": { + "type": "integer", + "description": "The token decimals", + "example": 18 + }, + "symbol": { + "type": "string", + "description": "The symbol of the token being transferred", + "example": "AAA" + }, + "image_url": { + "type": "string", + "description": "The image of the token being transferred", + "example": "https://some-url" } } }, - "DeleteUserRequest": { + "ERC20TransferFromMetadata": { "type": "object", + "required": [ + "transaction_type", + "immutable_verification_status", + "from_address", + "to_address", + "amount", + "decimals", + "symbol", + "image_url" + ], "properties": { - "email_address": { + "transaction_type": { "type": "string", - "format": "email", - "description": "The email address of the user to delete", - "example": "user@example.com" + "description": "Transaction type", + "enum": [ + "ERC20_TRANSFER_FROM" + ] }, - "reason": { + "from_address": { "type": "string", - "description": "The reason for deleting the user", - "example": "JIRA-123: User requested deletion" - } - }, - "required": [ - "email_address", - "reason" - ], - "example": [ - { - "email_address": "user@example.com", - "reason": "JIRA-123: User requested deletion" - } - ] - }, - "DeleteUserRes": { - "type": "object", - "properties": { - "email_address": { + "description": "The address to transfer the token from", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + }, + "to_address": { + "type": "string", + "description": "The address to transfer the token to", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + }, + "amount": { + "type": "string", + "description": "A string representing the amount of tokens to transfer", + "example": "10000000000000000" + }, + "immutable_verification_status": { + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + }, + "decimals": { + "type": "integer", + "description": "The token decimals", + "example": 18 + }, + "symbol": { "type": "string", - "description": "The email address of the user", - "example": "user@example.com" + "description": "The symbol of the token being transferred", + "example": "AAA" }, - "user_id": { + "image_url": { "type": "string", - "description": "The user id of the user", - "example": "google|1234" + "description": "The image of the token being transferred", + "example": "https://some-url" } - }, - "required": [ - "email_address", - "user_id" - ], - "example": { - "email_address": "user@example.com", - "user_id": "google|1234" } }, - "UpdateUserEmailRequest": { + "ERC20ApproveMetadata": { "type": "object", "required": [ - "wallet_address", - "email_address" + "transaction_type", + "amount", + "token_symbol", + "spender", + "is_smart_contract", + "is_contract_verified", + "immutable_verification_status", + "contract_name", + "image_url" ], "properties": { - "wallet_address": { + "transaction_type": { + "type": "string", + "description": "Transaction type", + "enum": [ + "ERC20_APPROVE" + ] + }, + "immutable_verification_status": { + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + }, + "amount": { "type": "string", - "description": "The user's wallet (eth) address to identify the user", - "pattern": "^0x[0-9a-fA-F]{40}$", - "maxLength": 42, - "example": "0x1234567890abcdef1234567890abcdef12345678" + "description": "Requested approval amount" }, - "email_address": { + "token_symbol": { "type": "string", - "format": "email", - "description": "The email address to set for the user", - "example": "user@example.com", - "maxLength": 256 + "description": "Requested token symbol" + }, + "spender": { + "type": "string", + "description": "Spender address" + }, + "is_smart_contract": { + "type": "boolean", + "description": "Indicate if it is a Smart Contract or EOA" + }, + "is_contract_verified": { + "type": "boolean", + "description": "Is Contract Verified" + }, + "contract_name": { + "type": "string", + "description": "Smart Contract Name" + }, + "image_url": { + "type": "string", + "example": "https://example.com/erc20.jpg" } - }, - "additionalProperties": false + } }, - "UpdateUserEmailRes": { + "NFTSetApprovalForAllMetadata": { "type": "object", "required": [ - "wallet_address" + "transaction_type", + "collection_name", + "collection_image", + "is_smart_contract", + "is_contract_verified", + "contract_name", + "immutable_verification_status" ], "properties": { - "wallet_address": { + "transaction_type": { + "type": "string", + "description": "Transaction type", + "enum": [ + "ERC721_SET_APPROVAL_FOR_ALL", + "ERC1155_SET_APPROVAL_FOR_ALL" + ] + }, + "collection_name": { + "type": "string", + "description": "NFT Collection name" + }, + "collection_image": { + "type": "string", + "description": "NFT Collection image" + }, + "is_smart_contract": { + "type": "boolean", + "description": "Indicate if it is a Smart Contract or EOA" + }, + "is_contract_verified": { + "type": "boolean", + "description": "Is Contract Verified" + }, + "contract_name": { "type": "string", - "description": "The wallet address that was updated", - "pattern": "^0x[0-9a-fA-F]{40}$", - "example": "0x1234567890abcdef1234567890abcdef12345678" + "description": "Smart Contract Name" + }, + "immutable_verification_status": { + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } } }, - "CreatePreOnboardingCheckInSessionActivityContractRequest": { + "ERC721TransferFromMetadata": { "type": "object", "required": [ - "contract_address", - "client_id", - "organisation_id" + "transaction_type", + "from_address", + "to_address", + "collection_name", + "token_id", + "asset_name", + "asset_image", + "immutable_verification_status" ], "properties": { - "contract_address": { + "transaction_type": { "type": "string", - "description": "The smart contract address to track session activity for", - "pattern": "^0x[0-9a-fA-F]{40}$", - "maxLength": 42, - "example": "0x1234567890abcdef1234567890abcdef12345678" + "description": "Transaction type", + "enum": [ + "ERC721_TRANSFER_FROM" + ] }, - "client_id": { + "from_address": { "type": "string", - "description": "The client ID associated with the session activity contract", - "pattern": "^[a-zA-Z0-9]{32}$", - "minLength": 32, - "maxLength": 32, - "example": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE" + "description": "The address to transfer the token from", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" }, - "organisation_id": { + "to_address": { "type": "string", - "format": "uuid", - "description": "The organisation ID that owns this session activity contract (UUID format)", - "example": "550e8400-e29b-41d4-a716-446655440000" - } - }, - "additionalProperties": false, - "example": { - "contract_address": "0x1234567890abcdef1234567890abcdef12345678", - "client_id": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE", - "organisation_id": "550e8400-e29b-41d4-a716-446655440000" - } - }, - "CreatePreOnboardingCheckInSessionActivityContractRes": { - "type": "object", - "required": [ - "id", - "contract_address", - "client_id", - "organisation_id", - "created_at" - ], - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the created session activity contract", - "example": 1 + "description": "The address to transfer the token to", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" }, - "contract_address": { + "collection_name": { "type": "string", - "description": "The smart contract address", - "pattern": "^0x[0-9a-fA-F]{40}$", - "minLength": 42, - "maxLength": 42, - "example": "0x1234567890abcdef1234567890abcdef12345678" + "description": "The collection name the ERC721 belongs to" }, - "client_id": { + "token_id": { "type": "string", - "description": "The client ID associated with the session activity contract", - "pattern": "^[a-zA-Z0-9]{32}$", - "minLength": 32, - "maxLength": 32, - "example": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE" + "description": "ID of the ERC721", + "example": "1" }, - "organisation_id": { + "asset_name": { "type": "string", - "format": "uuid", - "description": "The organisation ID that owns this session activity contract (UUID format)", - "example": "550e8400-e29b-41d4-a716-446655440000" + "description": "The name of the ERC721", + "example": "Sword" }, - "created_at": { + "asset_image": { "type": "string", - "format": "date-time", - "description": "The timestamp when the session activity contract was created", - "example": "2023-12-07T10:30:00Z" + "description": "The image of the ERC721", + "example": "https://some-url" + }, + "immutable_verification_status": { + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } - }, - "example": { - "id": 1, - "contract_address": "0x1234567890abcdef1234567890abcdef12345678", - "client_id": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE", - "organisation_id": "550e8400-e29b-41d4-a716-446655440000", - "created_at": "2023-12-07T10:30:00Z" } }, - "GetPreOnboardingCheckInSessionActivityContractsRes": { + "ERC721SafeTransferFromBatchMetadata": { "type": "object", "required": [ - "session_activity_contracts" + "transaction_type", + "from_address", + "collection_name", + "items", + "immutable_verification_status" ], "properties": { - "session_activity_contracts": { + "transaction_type": { + "type": "string", + "description": "Transaction type", + "enum": [ + "ERC721_SAFE_TRANSFER_FROM_BATCH" + ] + }, + "from_address": { + "type": "string", + "description": "The address to transfer the token from", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + }, + "collection_name": { + "type": "string", + "description": "The collection name the ERC721 belongs to", + "example": "Guild of Guardians Heroes" + }, + "items": { "type": "array", - "description": "List of session activity contracts", + "description": "The ERC721s to transfer and where to transfer them to", "items": { - "$ref": "#/components/schemas/PreOnboardingCheckInSessionActivityContract" + "$ref": "#/components/schemas/ERC721SafeTransferFromBatchItem" } + }, + "immutable_verification_status": { + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } - }, - "example": { - "session_activity_contracts": [ - { - "id": 1, - "contract_address": "0x1234567890abcdef1234567890abcdef12345678", - "client_id": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE", - "organisation_id": "550e8400-e29b-41d4-a716-446655440000", - "created_at": "2023-12-07T10:30:00Z" - }, - { - "id": 2, - "contract_address": "0xabcdef1234567890abcdef1234567890abcdef12", - "client_id": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE", - "organisation_id": "550e8400-e29b-41d4-a716-446655440000", - "created_at": "2023-12-07T11:00:00Z" - } - ] } }, - "PreOnboardingCheckInSessionActivityContract": { + "ERC721SafeTransferFromBatchItem": { "type": "object", "required": [ - "id", - "contract_address", - "client_id", - "organisation_id", - "created_at" + "to_address", + "token_id", + "asset_name", + "asset_image" ], "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the session activity contract", - "example": 1 - }, - "contract_address": { + "to_address": { "type": "string", - "description": "The smart contract address", - "pattern": "^0x[0-9a-fA-F]{40}$", - "minLength": 42, - "maxLength": 42, - "example": "0x1234567890abcdef1234567890abcdef12345678" + "description": "The address to transfer the token to", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F" }, - "client_id": { + "token_id": { "type": "string", - "description": "The client ID associated with the session activity contract", - "pattern": "^[a-zA-Z0-9]{32}$", - "minLength": 32, - "maxLength": 32, - "example": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE" + "description": "ID of the ERC721", + "example": "1" }, - "organisation_id": { + "asset_name": { "type": "string", - "format": "uuid", - "description": "The organisation ID that owns this session activity contract (UUID format)", - "example": "550e8400-e29b-41d4-a716-446655440000" + "description": "The name of the ERC721", + "example": "Sword" }, - "created_at": { + "asset_image": { "type": "string", - "format": "date-time", - "description": "The timestamp when the session activity contract was created", - "example": "2023-12-07T10:30:00Z" - } - } - }, - "DomainType": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - }, - "chainId": { - "oneOf": [ - { - "type": "integer" - }, - { - "type": "string" - } - ] - }, - "verifyingContract": { - "type": "string" - }, - "salt": { - "type": "string" - } - } - }, - "EIP712Message": { - "type": "object", - "properties": { - "types": { - "type": "object", - "properties": { - "EIP712Domain": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "name", - "type" - ] - } - } - }, - "additionalProperties": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "name", - "type" - ] - } - }, - "required": [ - "EIP712Domain" - ] - }, - "primaryType": { - "type": "string" - }, - "domain": { - "$ref": "#/components/schemas/DomainType" - }, - "message": { - "type": "object" - } - }, - "required": [ - "types", - "primaryType", - "domain", - "message" - ] - }, - "ProgramName": { - "type": "string", - "description": "Program ID", - "maxLength": 36 - }, - "EpochID": { - "type": "string", - "description": "Latest Epoch", - "enum": [ - "current" - ] - }, - "EthereumAddress": { - "type": "string", - "description": "Ethereum address", - "pattern": "^0x[a-fA-F0-9]{40}$", - "minLength": 42, - "maxLength": 42 - }, - "GetEpochResponseBody": { - "required": [ - "result" - ], - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/GetEpochResponseBodyResult" + "description": "The image of the ERC721", + "example": "https://some-url" } } }, - "GetEpochResponseBodyResult": { + "UnknownMetadata": { + "type": "object", "required": [ - "epoch", - "started_at", - "ended_at", - "contract_address", - "rewards_lifetime" + "transaction_type", + "is_smart_contract", + "is_contract_verified", + "contract_name" ], - "type": "object", "properties": { - "epoch": { - "type": "integer", - "format": "int32", - "description": "Epoch number" - }, - "started_at": { - "type": "string", - "format": "date-time", - "description": "Epoch start date" - }, - "ended_at": { + "transaction_type": { "type": "string", - "format": "date-time", - "description": "Epoch end date" - }, - "rewards_rate_last_cycle": { - "type": "number", - "description": "Rewards rate last cycle", - "format": "float" + "description": "Transaction type", + "enum": [ + "UNKNOWN" + ] }, - "finalised_at_last_cycle": { - "type": "string", - "format": "date-time", - "description": "Finalised at for the previous epoch" + "is_smart_contract": { + "type": "boolean", + "description": "Indicate if it is a Smart Contract or EOA" }, - "contract_address": { - "$ref": "#/components/schemas/EthereumAddress" + "is_contract_verified": { + "type": "boolean", + "description": "Is Contract Verified" }, - "rewards_lifetime": { + "contract_name": { "type": "string", - "description": "Total amount of rewards earned globally", - "pattern": "^\\d+$" - }, - "average_rewards_rate": { - "type": "number", - "description": "Average rewards rate historically", - "format": "float" + "description": "Smart Contract Name" } } }, - "GetWalletStakingInfoResponseBody": { + "UnknownTypedDataMetadata": { + "type": "object", "required": [ - "result" + "typed_data_type" ], - "type": "object", "properties": { - "result": { - "$ref": "#/components/schemas/GetWalletStakingInfoResponseBodyResult" + "typed_data_type": { + "type": "string", + "description": "Unknown typed data type", + "enum": [ + "UNKNOWN" + ] } } }, - "GetWalletStakingInfoResponseBodyResult": { + "SeaportFulfillAvailableAdvancedOrdersMetadata": { + "type": "object", "required": [ - "rewards_lifetime", - "did_trade_this_cycle" + "transaction_type", + "is_smart_contract", + "is_contract_verified", + "contract_name", + "buy", + "sell", + "fees" ], - "type": "object", "properties": { - "rewards_lifetime": { + "transaction_type": { "type": "string", - "description": "Total amount of rewards earned by this wallet", - "pattern": "^\\d+$" + "description": "Transaction type", + "enum": [ + "SEAPORT_FULFILL_AVAILABLE_ADVANCED_ORDERS" + ] }, - "rewards_last_cycle": { - "type": "string", - "description": "Amount of rewards earned last cycle by this wallet", - "pattern": "^\\d+$" + "is_smart_contract": { + "type": "boolean", + "description": "Indicate if it is a Smart Contract or EOA" }, - "did_trade_this_cycle": { + "is_contract_verified": { "type": "boolean", - "description": "Whether this wallet traded this cycle" + "description": "Is Contract Verified" + }, + "contract_name": { + "type": "string", + "description": "Smart Contract Name" + }, + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeaportAdvancedOrder" + } } } }, - "EthAddress": { - "description": "Ethereum address", - "type": "string", - "example": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045" - }, - "CreatedAt": { - "description": "Created at", - "type": "string", - "format": "date-time", - "example": "2021-08-31T00:00:00Z" - }, - "UpdatedAt": { - "description": "Updated at", - "type": "string", - "format": "date-time", - "example": "2021-08-31T00:00:00Z" - }, - "Name": { - "description": "Name", - "type": "string", - "example": "Test" + "SeaportAdvancedOrder": { + "type": "object", + "properties": { + "buy": { + "oneOf": [ + { + "$ref": "#/components/schemas/SeaportNativeItem" + }, + { + "$ref": "#/components/schemas/SeaportERC20Item" + }, + { + "$ref": "#/components/schemas/SeaportERC1155Item" + }, + { + "$ref": "#/components/schemas/SeaportERC1155CollectionItem" + }, + { + "$ref": "#/components/schemas/SeaportERC721Item" + }, + { + "$ref": "#/components/schemas/SeaportERC721CollectionItem" + } + ], + "example": [ + { + "type": "NATIVE", + "amount": "10000000000000000", + "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F" + } + ] + }, + "sell": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/SeaportERC1155Item" + }, + { + "$ref": "#/components/schemas/SeaportERC721Item" + }, + { + "$ref": "#/components/schemas/SeaportNativeItem" + }, + { + "$ref": "#/components/schemas/SeaportERC20Item" + } + ] + }, + "fees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeaportFee" + }, + "example": [], + "minItems": 0 + } + }, + "required": [ + "buy", + "sell", + "fees" + ] }, - "WalletType": { - "description": "Wallet type", - "type": "string", - "example": "MetaMask" + "SeaportNativeItem": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Token type user is offering, which in this case is the native IMX token", + "example": "NATIVE", + "enum": [ + "NATIVE" + ] + }, + "amount": { + "type": "string", + "description": "A string representing the price at which the user is willing to sell the token", + "example": "10000000000000000" + }, + "decimals": { + "type": "integer", + "description": "The decimal of this item", + "example": 18 + } + }, + "required": [ + "type", + "amount", + "decimals" + ] }, - "Wallet": { - "description": "Linked wallet", + "SeaportERC20Item": { "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Token type user is offering, which in this case is ERC20", + "example": "ERC20", + "enum": [ + "ERC20" + ] + }, + "contract_address": { + "type": "string", + "description": "Address of ERC20 token", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F", + "pattern": "^0x[a-fA-F0-9]{40}$" + }, + "symbol": { + "type": "string", + "description": "The symbol of token", + "example": "AAA", + "nullable": true + }, + "image_url": { + "type": "string", + "description": "The image url of token", + "example": "https://some-url", + "nullable": true + }, + "amount": { + "type": "string", + "description": "A string representing the price at which the user is willing to sell the token", + "example": "10000000000000000" + }, + "decimals": { + "type": "integer", + "description": "The decimal of this erc20 item", + "example": 18 + }, + "immutable_verification_status": { + "type": "string", + "description": "The Immutable verification status of this collection", + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" + } + }, "required": [ - "address", "type", - "created_at", - "updated_at", - "clientName" - ], + "contract_address", + "amount", + "decimals", + "immutable_verification_status" + ] + }, + "SeaportERC721Item": { + "type": "object", "properties": { - "address": { - "$ref": "#/components/schemas/EthAddress" - }, "type": { - "$ref": "#/components/schemas/WalletType" + "type": "string", + "description": "Token type user is offering, which in this case is ERC721", + "example": "ERC721", + "enum": [ + "ERC721" + ] }, - "created_at": { - "$ref": "#/components/schemas/CreatedAt" + "contract_address": { + "type": "string", + "description": "Address of ERC721 token", + "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "updated_at": { - "$ref": "#/components/schemas/CreatedAt" + "contract_name": { + "type": "string", + "nullable": true, + "description": "The name of the collection", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" + }, + "image_url": { + "type": "string", + "description": "The URL of the NFT", + "example": "https://example.com/nft.jpeg" }, "name": { - "$ref": "#/components/schemas/Name" + "type": "string", + "nullable": true, + "example": "Sword", + "description": "The name of the NFT" }, - "clientName": { + "token_id": { "type": "string", - "description": "Name of client that linked the wallet", - "example": "Passport Dashboard" - } - } - }, - "PhoneNumberOTPRequest": { - "description": "Phone number OTP request", - "type": "object", - "required": [ - "phone_number" - ], - "properties": { - "phone_number": { - "$ref": "#/components/schemas/PhoneNumber" + "description": "ID of ERC721 token", + "example": "1", + "pattern": "\\d+" }, - "channel": { - "enum": [ - "sms", - "whatsapp" - ], + "immutable_verification_status": { "type": "string", - "example": "sms" + "description": "The Immutable verification status of this collection", + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } - } - }, - "PhoneNumberOTPResponse": { - "description": "Phone number OTP request", - "type": "object", - "required": [ - "phone_number" - ], - "properties": { - "phone_number": { - "$ref": "#/components/schemas/PhoneNumber" + }, + "example": [ + { + "type": "ERC721", + "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", + "contract_name": "Guild of Guardians Heroes", + "name": "Bestowing Saint", + "token_id": "1", + "immutable_verification_status": "verified" } - } - }, - "PhoneNumberOTPVerificationRequest": { - "description": "Phone number OTP verification request", - "type": "object", - "required": [ - "phone_number", - "code" ], - "properties": { - "phone_number": { - "$ref": "#/components/schemas/PhoneNumber" - }, - "code": { - "$ref": "#/components/schemas/PhoneNumberOTP" - } - } - }, - "PhoneNumber": { - "description": "Phone number", - "type": "string", - "example": "+61412345678", - "minLength": 3, - "maxLength": 50 - }, - "PhoneNumberOTP": { - "description": "Phone number verification OTP", - "type": "string", - "example": "123456", - "maxLength": 6, - "minLength": 6 - }, - "LinkWalletV2Request": { - "description": "Link wallet V2 request", - "type": "object", "required": [ "type", - "wallet_address", - "signature", - "nonce" - ], + "contract_address", + "token_id", + "immutable_verification_status" + ] + }, + "SeaportERC1155Item": { + "type": "object", "properties": { "type": { "type": "string", - "description": "This should be the EIP-6963 rdns value, if you're unable to get the rdns value you can provide \"External\". If using WalletConnect then provide \"WalletConnect\".", - "example": "io.metamask", - "maxLength": 32, - "not": { - "enum": [ - "Passport", - "com.immutable.passport" - ] - } + "description": "Token type user is offering, which in this case is ERC1155", + "example": "ERC1155", + "enum": [ + "ERC1155" + ] }, - "wallet_address": { - "description": "The address of the external wallet being linked to Passport", + "contract_address": { "type": "string", - "example": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", + "description": "Address of ERC1155 token", + "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", "pattern": "^0x[a-fA-F0-9]{40}$" }, - "signature": { - "description": "The EIP-712 signature", - "type": "string" + "contract_name": { + "type": "string", + "nullable": true, + "description": "The name of the collection", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "nonce": { - "description": "A unique identifier for the signature", - "type": "string" + "image_url": { + "type": "string", + "description": "The URL of the asset", + "example": "https://example.com/nft.jpeg" + }, + "name": { + "type": "string", + "nullable": true, + "example": "Sword", + "description": "The name of the asset" + }, + "token_id": { + "type": "string", + "description": "ID of ERC1155 token", + "example": "1", + "pattern": "\\d+" + }, + "amount": { + "type": "string", + "description": "A string representing the total units of an ERC1155 token which the user is buying/selling", + "example": "100" + }, + "immutable_verification_status": { + "type": "string", + "description": "The Immutable verification status of this collection", + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } - } + }, + "example": [ + { + "type": "ERC1155", + "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", + "contract_name": "Guild of Guardians Heroes", + "name": "Bestowing Saint", + "token_id": "1", + "amount": "100", + "immutable_verification_status": "verified" + } + ], + "required": [ + "type", + "contract_address", + "token_id", + "amount", + "immutable_verification_status" + ] }, - "UserInfo": { + "SeaportERC721CollectionItem": { "type": "object", - "required": [ - "sub", - "linked_addresses" - ], "properties": { - "sub": { + "type": { + "type": "string", + "description": "Token type user is offering, which in this case is ERC721Collection", + "example": "ERC721Collection", + "enum": [ + "ERC721Collection" + ] + }, + "contract_address": { + "type": "string", + "description": "Address of ERC721 token", + "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "pattern": "^0x[a-fA-F0-9]{40}$" + }, + "contract_name": { "type": "string", - "description": "The user's id" + "nullable": true, + "description": "The name of the collection", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "email": { + "image_url": { "type": "string", - "description": "The user's email address" + "description": "The URL of the collection image", + "example": "https://example.com/nft.jpeg" }, - "passport_address": { + "amount": { "type": "string", - "description": "The user's Passport address if it has been registered", - "pattern": "^0x[0-9a-fA-F]*$", - "maxLength": 42 + "description": "A string representing the total units of an ERC721 token which the user is buying", + "example": "10" }, - "linked_addresses": { - "type": "array", - "minItems": 0, - "description": "The user's list of linked addresses", - "items": { - "description": "The user's linked address", - "type": "string", - "pattern": "^0x[0-9a-fA-F]*$", - "maxLength": 42 - } + "immutable_verification_status": { + "type": "string", + "description": "The Immutable verification status of this collection", + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } - } + }, + "example": [ + { + "type": "ERC721Collection", + "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", + "amount": "10", + "immutable_verification_status": "verified" + } + ], + "required": [ + "type", + "contract_address", + "image_url", + "amount", + "immutable_verification_status" + ] }, - "FeedItemBase": { + "SeaportERC1155CollectionItem": { "type": "object", "properties": { - "id": { - "type": "string", - "description": "Feed item ID" - }, - "name": { + "type": { "type": "string", - "description": "Feed item name" + "description": "Token type user is offering, which in this case is ERC1155Collection", + "example": "ERC1155Collection", + "enum": [ + "ERC1155Collection" + ] }, - "quest_id": { + "contract_address": { "type": "string", - "description": "Quest ID", - "minLength": 1, - "maxLength": 100, - "pattern": "^[a-z0-9-]+$" - }, - "priority": { - "type": "integer", - "description": "Feed item priority" - }, - "gems_earnable": { - "type": "integer", - "description": "Amount of gems earnable when user completes the quest" - }, - "bypass": { - "type": "boolean", - "description": "If the quest is bypassed, the user will not be able to see it on the feed" - }, - "day_zero": { - "type": "boolean", - "description": "If the quest is a day0 quest" + "description": "Address of ERC1155 token", + "example": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "game_id": { + "image_url": { "type": "string", - "description": "Game ID", - "format": "uuid" + "description": "The URL of the collection image", + "example": "https://example.com/nft.jpeg" }, - "game_name": { + "contract_name": { "type": "string", - "description": "Game name" + "nullable": true, + "description": "The name of the collection", + "example": "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e" }, - "quest_completed_popup_text": { + "amount": { "type": "string", - "description": "Text to display when the quest is completed in an onboarding experience" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The tags for the feed item" - }, - "control_tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Some specific tags for controlling feed items" - }, - "categories": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The categories for the feed item" + "description": "A string representing the total units of an ERC1155 token which the user is buying", + "example": "100" }, - "onboarding_experience": { + "immutable_verification_status": { "type": "string", - "description": "The onboarding experience for the feed item" + "description": "The Immutable verification status of this collection", + "$ref": "#/components/schemas/ImmutableVerificationStatusEnum" } }, + "example": [ + { + "type": "ERC1155", + "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", + "contract_name": "Guild of Guardians Heroes", + "amount": "100", + "immutable_verification_status": "verified" + } + ], "required": [ - "id", - "name", - "quest_id", - "priority", "type", - "gems_earnable" + "image_url", + "contract_address", + "amount", + "immutable_verification_status" ] }, - "FeedItemVideo": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemBase" + "SeaportFee": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Token type of the Fee", + "example": "ERC20", + "enum": [ + "ERC20", + "NATIVE" + ] }, - { - "type": "object" + "amount": { + "type": "string", + "description": "Fee payable to recipient upon settlement", + "example": "10000000000000000" }, - { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "video" - ] - }, - "title": { - "type": "string", - "description": "Title of the video" - }, - "url": { - "type": "string", - "description": "URL of the video", - "format": "uri" - } - }, - "required": [ - "type", - "title", - "url" - ] - } - ] - }, - "FeedItemFollowGame": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemBase" + "recipient_address": { + "type": "string", + "description": "Wallet address of fee recipient", + "example": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - { - "type": "object" + "contract_address": { + "type": "string", + "description": "Address of the ERC20 token for the fee", + "example": "0x0165878A594ca255338adfa4d48449f69242Eb8F", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "followgame" - ] - }, - "image": { - "type": "string", - "description": "URL of the CTA image", - "format": "uri" - }, - "label": { - "type": "string", - "description": "Label of the CTA button" - }, - "description": { - "type": "string", - "description": "Description of the CTA button" - }, - "logo": { - "type": "string", - "description": "URL of the quiz logo", - "format": "uri" - }, - "title": { - "type": "string", - "description": "Title of the video" - }, - "similar_games": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Similar games to display" - } - }, - "required": [ - "type", - "image", - "label", - "description", - "logo", - "title" - ] + "symbol": { + "type": "string", + "description": "The symbol of token for the fee", + "example": "AAA", + "nullable": true + }, + "decimals": { + "type": "integer", + "description": "The decimal of this item", + "example": 18 } + }, + "example": { + "amount": "10000000000000000", + "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233", + "type": "NATIVE" + }, + "required": [ + "amount", + "type", + "recipient_address", + "decimals" ] }, - "FeedItemQuiz": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemBase" - }, - { - "type": "object" - }, - { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "quiz" - ] - }, - "header_video_url": { - "type": "string", - "description": "URL of the quiz header video", - "format": "uri" - }, - "logo": { - "type": "string", - "description": "URL of the quiz logo", - "format": "uri" - }, - "question": { - "type": "string", - "description": "The quiz question" - }, - "answers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Quiz answers to display" - }, - "correct_answers": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Quiz correct answers" - }, - "correct_answer_text": { - "type": "string", - "description": "The text to display when the user answers the quiz correctly" - }, - "header_initial_image": { - "type": "string", - "description": "The initial image for the quiz header", - "format": "uri" - }, - "header_answered_image": { - "type": "string", - "description": "The image to display when the user answers the quiz correctly", - "format": "uri" - } - }, - "required": [ - "type", - "question", - "answers", - "correct_answers" + "SeaportCreateListingMetadata": { + "type": "object", + "required": [ + "typed_data_type", + "buy", + "sell", + "fees" + ], + "properties": { + "typed_data_type": { + "type": "string", + "description": "Typed data type", + "enum": [ + "SEAPORT_CREATE_LISTING_METADATA" ] - } - ] - }, - "FeedItemCTA": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemBase" - }, - { - "type": "object" }, - { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "cta" - ] + "buy": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/SeaportNativeItem" }, - "label": { - "type": "string", - "description": "The label for the CTA button" + { + "$ref": "#/components/schemas/SeaportERC20Item" }, - "description": { - "type": "string", - "description": "The description for the CTA button" + { + "$ref": "#/components/schemas/SeaportERC721Item" }, - "url": { - "type": "string", - "description": "The URL for the CTA button" + { + "$ref": "#/components/schemas/SeaportERC721CollectionItem" }, - "image": { - "type": "string", - "description": "The image for the CTA background", - "format": "uri" + { + "$ref": "#/components/schemas/SeaportERC1155Item" + }, + { + "$ref": "#/components/schemas/SeaportERC1155CollectionItem" + } + ], + "example": [ + { + "type": "ERC721", + "contract_address": "0x87c07c927eba711cbc55ec628a670acd48d0b525", + "contract_name": "Guild of Guardians Heroes", + "name": "Bestowing Saint", + "token_id": 1 } - }, - "required": [ - "type", - "label", - "description", - "url", - "image" ] - } - ] - }, - "FeedItemSignIn": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemCTA" - }, - { - "type": "object" }, - { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "signin" - ] + "sell": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/SeaportNativeItem" }, - "redirect_url": { - "type": "string", - "description": "The URL to redirect to when the user completes the sign in quest", - "format": "uri" + { + "$ref": "#/components/schemas/SeaportERC20Item" }, - "background": { - "type": "string", - "description": "The background for the sign in quest", - "format": "uri" + { + "$ref": "#/components/schemas/SeaportERC721Item" + }, + { + "$ref": "#/components/schemas/SeaportERC1155Item" } - }, - "required": [ - "type", - "redirect_url", - "background" ] - } - ] - }, - "FeedItemReward": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemSignIn" - }, - { - "type": "object" }, - { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "reward" - ] - } + "fees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeaportFee" } } - ] + } }, - "FeedItemLanding": { - "allOf": [ + "GetTransactionMetadataRes": { + "type": "object", + "oneOf": [ { - "$ref": "#/components/schemas/FeedItemBase" + "$ref": "#/components/schemas/ERC20ApproveMetadata" }, { - "type": "object" + "$ref": "#/components/schemas/ERC20TransferMetadata" }, { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "landing" - ] - } - }, - "required": [ - "type" - ] - } - ] - }, - "FeedItemPinToHome": { - "allOf": [ + "$ref": "#/components/schemas/ERC20TransferFromMetadata" + }, { - "$ref": "#/components/schemas/FeedItemBase" + "$ref": "#/components/schemas/ERC721ApproveMetadata" }, { - "type": "object" + "$ref": "#/components/schemas/NFTSetApprovalForAllMetadata" }, { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "pintohome" - ] - } - }, - "required": [ - "type" - ] - } - ] - }, - "FeedItemDailyGems": { - "allOf": [ + "$ref": "#/components/schemas/ERC721TransferFromMetadata" + }, { - "$ref": "#/components/schemas/FeedItemBase" + "$ref": "#/components/schemas/ERC721SafeTransferFromBatchMetadata" }, { - "type": "object" + "$ref": "#/components/schemas/SeaportFulfillAvailableAdvancedOrdersMetadata" }, { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "dailygems" - ] - } - }, - "required": [ - "type" - ] + "$ref": "#/components/schemas/UnknownMetadata" } ] }, - "FeedItemBonusGems": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemBase" - }, + "GetTypedDataMetadataRes": { + "type": "object", + "oneOf": [ { - "type": "object" + "$ref": "#/components/schemas/SeaportCreateListingMetadata" }, { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "bonusgems" - ] - } - }, - "required": [ - "type" - ] + "$ref": "#/components/schemas/UnknownTypedDataMetadata" } ] }, - "FeedItemReferral": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemBase" + "GetTypedDataMetadataRequest": { + "type": "object", + "required": [ + "payload" + ], + "properties": { + "payload": { + "$ref": "#/components/schemas/EIP712Message" + } + } + }, + "DomainType": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - { - "type": "object" + "version": { + "type": "string" }, - { - "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "referral" - ] + "chainId": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" } - }, - "required": [ - "type" ] - } - ] - }, - "FeedItemSocialQuest": { - "allOf": [ - { - "$ref": "#/components/schemas/FeedItemBase" }, - { - "type": "object" + "verifyingContract": { + "type": "string" }, - { + "salt": { + "type": "string" + } + } + }, + "EIP712Message": { + "type": "object", + "properties": { + "types": { + "type": "object", "properties": { - "type": { - "type": "string", - "description": "Feed item type", - "enum": [ - "socialquest" - ] - }, - "title": { - "type": "string", - "description": "Title of the social quest" - }, - "subtitle": { - "type": "string", - "description": "Title of the social quest" - }, - "label": { - "type": "string", - "description": "The label for the CTA button" - }, - "description": { - "type": "string", - "description": "The description for the CTA button" - }, - "url": { - "type": "string", - "description": "The URL for the CTA button" - }, - "logo": { - "type": "string", - "description": "URL of the logo", - "format": "uri" - }, - "platform_name": { - "type": "string", - "description": "The name of the platform social quest belongs to" + "EIP712Domain": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + } + } + }, + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "name", + "type" + ] } }, "required": [ - "type", - "title", - "subtitle", - "label", - "description", - "url", - "logo", - "platform_name" + "EIP712Domain" ] - } - ] - }, - "FeedItemResponse": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Feed item status, e.g., enabled, disabled, archived, deleted" - }, - "created_at": { - "$ref": "#/components/schemas/CreatedAt" - }, - "updated_at": { - "$ref": "#/components/schemas/UpdatedAt" - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/FeedItemVideo" - }, - { - "$ref": "#/components/schemas/FeedItemQuiz" - }, - { - "$ref": "#/components/schemas/FeedItemCTA" - }, - { - "$ref": "#/components/schemas/FeedItemSignIn" - }, - { - "$ref": "#/components/schemas/FeedItemReward" - }, - { - "$ref": "#/components/schemas/FeedItemLanding" - }, - { - "$ref": "#/components/schemas/FeedItemPinToHome" - }, - { - "$ref": "#/components/schemas/FeedItemDailyGems" - }, - { - "$ref": "#/components/schemas/FeedItemBonusGems" }, - { - "$ref": "#/components/schemas/FeedItemReferral" + "primaryType": { + "type": "string" }, - { - "$ref": "#/components/schemas/FeedItemFollowGame" + "domain": { + "$ref": "#/components/schemas/DomainType" }, - { - "$ref": "#/components/schemas/FeedItemSocialQuest" - } - ] - }, - "FeedItemResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/components/schemas/FeedItemResponse" + "message": { + "type": "object" } }, "required": [ - "result" + "types", + "primaryType", + "domain", + "message" ] }, - "FeedItemsResponsePage": { - "type": "object", - "properties": { - "offset": { - "type": "integer", - "description": "Offset for pagination" - }, - "limit": { - "type": "integer" - }, - "total": { - "type": "integer", - "description": "Total number of items" - } - } + "ProgramName": { + "type": "string", + "description": "Program ID", + "maxLength": 36 }, - "FeedItemsAssetsResponsePage": { - "type": "object", - "properties": { - "previous_cursor": { - "type": "string", - "nullable": true, - "description": "Previous page cursor" - }, - "next_cursor": { - "type": "string", - "nullable": true, - "description": "Next page cursor" - } - }, - "required": [ - "previous_cursor", - "next_cursor" + "EpochID": { + "type": "string", + "description": "Latest Epoch", + "enum": [ + "current" ] }, - "FeedItemsResponse": { - "description": "Feed item response page", + "EthereumAddress": { + "type": "string", + "description": "Ethereum address", + "pattern": "^0x[a-fA-F0-9]{40}$", + "minLength": 42, + "maxLength": 42 + }, + "GetEpochResponseBody": { + "required": [ + "result" + ], "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/FeedItemsResponsePage" - }, "result": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeedItemResponse" - }, - "minItems": 0, - "maxItems": 100 + "$ref": "#/components/schemas/GetEpochResponseBodyResult" } - }, - "required": [ - "page", - "result" - ] + } }, - "CreateUpdateFeedItemRequest": { + "GetEpochResponseBodyResult": { + "required": [ + "epoch", + "started_at", + "ended_at", + "contract_address", + "rewards_lifetime" + ], "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/FeedItemVideo" - }, - { - "$ref": "#/components/schemas/FeedItemQuiz" - }, - { - "$ref": "#/components/schemas/FeedItemCTA" - }, - { - "$ref": "#/components/schemas/FeedItemSignIn" - }, - { - "$ref": "#/components/schemas/FeedItemReward" + "properties": { + "epoch": { + "type": "integer", + "format": "int32", + "description": "Epoch number" }, - { - "$ref": "#/components/schemas/FeedItemLanding" + "started_at": { + "type": "string", + "format": "date-time", + "description": "Epoch start date" }, - { - "$ref": "#/components/schemas/FeedItemPinToHome" + "ended_at": { + "type": "string", + "format": "date-time", + "description": "Epoch end date" }, - { - "$ref": "#/components/schemas/FeedItemDailyGems" + "rewards_rate_last_cycle": { + "type": "number", + "description": "Rewards rate last cycle", + "format": "float" }, - { - "$ref": "#/components/schemas/FeedItemBonusGems" + "finalised_at_last_cycle": { + "type": "string", + "format": "date-time", + "description": "Finalised at for the previous epoch" }, - { - "$ref": "#/components/schemas/FeedItemReferral" + "contract_address": { + "$ref": "#/components/schemas/EthereumAddress" }, - { - "$ref": "#/components/schemas/FeedItemFollowGame" + "rewards_lifetime": { + "type": "string", + "description": "Total amount of rewards earned globally", + "pattern": "^\\d+$" }, - { - "$ref": "#/components/schemas/FeedItemSocialQuest" + "average_rewards_rate": { + "type": "number", + "description": "Average rewards rate historically", + "format": "float" } + } + }, + "GetWalletStakingInfoResponseBody": { + "required": [ + "result" ], - "discriminator": { - "propertyName": "type", - "mapping": { - "video": "#/components/schemas/FeedItemVideo", - "quiz": "#/components/schemas/FeedItemQuiz", - "cta": "#/components/schemas/FeedItemCTA", - "signin": "#/components/schemas/FeedItemSignIn", - "reward": "#/components/schemas/FeedItemReward", - "landing": "#/components/schemas/FeedItemLanding", - "pintohome": "#/components/schemas/FeedItemPinToHome", - "dailygems": "#/components/schemas/FeedItemDailyGems", - "bonusgems": "#/components/schemas/FeedItemBonusGems", - "referral": "#/components/schemas/FeedItemReferral", - "followgame": "#/components/schemas/FeedItemFollowGame", - "socialquest": "#/components/schemas/FeedItemSocialQuest" + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/GetWalletStakingInfoResponseBodyResult" } } }, - "FeedItemsStatusRequest": { + "GetWalletStakingInfoResponseBodyResult": { + "required": [ + "rewards_lifetime", + "did_trade_this_cycle" + ], "type": "object", "properties": { - "ids": { - "type": "array", - "description": "Feed item ids to have status updated", - "items": { - "type": "string" - } + "rewards_lifetime": { + "type": "string", + "description": "Total amount of rewards earned by this wallet", + "pattern": "^\\d+$" }, - "action": { + "rewards_last_cycle": { "type": "string", - "description": "The action to be applied in feed item status", - "enum": [ - "publish", - "unpublish", - "archive", - "unarchive", - "delete" - ] + "description": "Amount of rewards earned last cycle by this wallet", + "pattern": "^\\d+$" + }, + "did_trade_this_cycle": { + "type": "boolean", + "description": "Whether this wallet traded this cycle" } } }, - "FeedItemsStatusResponse": { + "EthAddress": { + "description": "Ethereum address", + "type": "string", + "example": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045" + }, + "CreatedAt": { + "description": "Created at", + "type": "string", + "format": "date-time", + "example": "2021-08-31T00:00:00Z" + }, + "Name": { + "description": "Name", + "type": "string", + "example": "Test" + }, + "WalletType": { + "description": "Wallet type", + "type": "string", + "example": "MetaMask" + }, + "Wallet": { + "description": "Linked wallet", "type": "object", + "required": [ + "address", + "type", + "created_at", + "updated_at", + "clientName" + ], "properties": { - "success": { - "type": "array", - "description": "Successfully updated feed items ids", - "items": { - "type": "string" - } + "address": { + "$ref": "#/components/schemas/EthAddress" + }, + "type": { + "$ref": "#/components/schemas/WalletType" + }, + "created_at": { + "$ref": "#/components/schemas/CreatedAt" + }, + "updated_at": { + "$ref": "#/components/schemas/CreatedAt" + }, + "name": { + "$ref": "#/components/schemas/Name" }, - "errors": { - "type": "array", - "description": "Failed to update status feed items ids", - "items": { - "type": "string" - } + "clientName": { + "type": "string", + "description": "Name of client that linked the wallet", + "example": "Passport Dashboard" } } }, - "FeedItemAssetResponse": { - "description": "Feed item response page", + "PhoneNumberOTPRequest": { + "description": "Phone number OTP request", "type": "object", + "required": [ + "phone_number" + ], "properties": { - "name": { - "type": "string", - "description": "Asset name" - }, - "type": { - "type": "string", - "description": "Asset type" + "phone_number": { + "$ref": "#/components/schemas/PhoneNumber" }, - "last_modified": { - "description": "Last Modified", + "channel": { + "enum": [ + "sms", + "whatsapp" + ], "type": "string", - "format": "date-time", - "example": "2021-08-31T00:00:00Z" - }, - "size": { - "type": "integer", - "description": "Asset size" + "example": "sms" } } }, - "CreateFeedItemsAssetsRequest": { - "description": "Feed item asset response for creation", + "PhoneNumberOTPResponse": { + "description": "Phone number OTP request", "type": "object", + "required": [ + "phone_number" + ], "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "base64Data": { - "type": "string" - }, - "sizeBytes": { - "type": "integer" + "phone_number": { + "$ref": "#/components/schemas/PhoneNumber" } } }, - "FeedItemsAssetsResponse": { - "description": "Feed item response page", + "PhoneNumberOTPVerificationRequest": { + "description": "Phone number OTP verification request", "type": "object", + "required": [ + "phone_number", + "code" + ], "properties": { - "page": { - "$ref": "#/components/schemas/FeedItemsAssetsResponsePage" + "phone_number": { + "$ref": "#/components/schemas/PhoneNumber" }, - "result": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeedItemAssetResponse" - }, - "minItems": 0, - "maxItems": 100 + "code": { + "$ref": "#/components/schemas/PhoneNumberOTP" } - }, - "required": [ - "page", - "result" - ] + } + }, + "PhoneNumber": { + "description": "Phone number", + "type": "string", + "example": "+61412345678", + "minLength": 3, + "maxLength": 50 + }, + "PhoneNumberOTP": { + "description": "Phone number verification OTP", + "type": "string", + "example": "123456", + "maxLength": 6, + "minLength": 6 }, - "InternalAssetResponse": { - "description": "Internal asset response with CDN URL", + "LinkWalletV2Request": { + "description": "Link wallet V2 request", "type": "object", + "required": [ + "type", + "wallet_address", + "signature", + "nonce" + ], "properties": { - "name": { + "type": { "type": "string", - "description": "Asset filename" - }, - "size": { - "type": "integer", - "description": "Asset size in bytes" + "description": "This should be the EIP-6963 rdns value, if you're unable to get the rdns value you can provide \"External\". If using WalletConnect then provide \"WalletConnect\".", + "example": "io.metamask", + "maxLength": 32, + "not": { + "enum": [ + "Passport", + "com.immutable.passport" + ] + } }, - "last_modified": { + "wallet_address": { + "description": "The address of the external wallet being linked to Passport", "type": "string", - "format": "date-time", - "description": "Last modified timestamp" + "example": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", + "pattern": "^0x[a-fA-F0-9]{40}$" }, - "cdn_url": { - "type": "string", - "description": "CDN URL to access the asset" - } - }, - "required": [ - "name", - "size", - "last_modified", - "cdn_url" - ] - }, - "InternalAssetsPage": { - "type": "object", - "properties": { - "previous_cursor": { - "type": "string", - "nullable": true, - "description": "Previous page cursor" + "signature": { + "description": "The EIP-712 signature", + "type": "string" }, - "next_cursor": { - "type": "string", - "nullable": true, - "description": "Next page cursor" + "nonce": { + "description": "A unique identifier for the signature", + "type": "string" } - }, - "required": [ - "previous_cursor", - "next_cursor" - ] + } }, - "InternalAssetsResponse": { - "description": "Internal assets list response", + "UserInfo": { "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/InternalAssetsPage" - }, - "result": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InternalAssetResponse" - }, - "minItems": 0, - "maxItems": 100 - } - }, "required": [ - "page", - "result" - ] - }, - "InternalPresignUploadResponse": { - "description": "Presigned upload URL response for internal assets", - "type": "object", + "sub", + "linked_addresses" + ], "properties": { - "url": { + "sub": { "type": "string", - "description": "Presigned PUT URL for uploading the asset (valid for 15 minutes)" + "description": "The user's id" }, - "cdn_url": { + "email": { "type": "string", - "description": "CDN URL where the asset will be accessible after upload" + "description": "The user's email address" }, - "content_type": { + "passport_address": { "type": "string", - "description": "Content-Type that must be used when uploading" + "description": "The user's Passport address if it has been registered", + "pattern": "^0x[0-9a-fA-F]*$", + "maxLength": 42 + }, + "linked_addresses": { + "type": "array", + "minItems": 0, + "description": "The user's list of linked addresses", + "items": { + "description": "The user's linked address", + "type": "string", + "pattern": "^0x[0-9a-fA-F]*$", + "maxLength": 42 + } } - }, - "required": [ - "url", - "cdn_url", - "content_type" - ] + } }, "ProfileResponse": { "description": "Get profile by wallet response", @@ -17878,144 +13975,6 @@ } } }, - "SessionActivityContractsResponse": { - "type": "object", - "required": [ - "session_activity_contracts" - ], - "properties": { - "session_activity_contracts": { - "type": "array", - "description": "List of session activity contracts", - "items": { - "$ref": "#/components/schemas/SessionActivityContractResponse" - } - } - }, - "example": { - "session_activity_contracts": [ - { - "id": 1, - "contract_address": "0x1234567890abcdef1234567890abcdef12345678", - "client_id": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE", - "organisation_id": "550e8400-e29b-41d4-a716-446655440000", - "created_at": "2023-12-07T10:30:00Z" - }, - { - "id": 2, - "contract_address": "0xabcdef1234567890abcdef1234567890abcdef12", - "client_id": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE", - "organisation_id": "550e8400-e29b-41d4-a716-446655440000", - "created_at": "2023-12-07T11:00:00Z" - } - ] - } - }, - "SessionActivityContractResponse": { - "allOf": [ - { - "$ref": "#/components/schemas/SessionActivityContract" - }, - { - "type": "object" - }, - { - "required": [ - "id", - "name", - "client_id", - "contract_address", - "chain_id", - "organisation_id", - "enabled", - "created_at" - ] - } - ] - }, - "UpsertSessionActivityContractReq": { - "allOf": [ - { - "$ref": "#/components/schemas/SessionActivityContract" - }, - { - "type": "object" - }, - { - "required": [ - "name", - "contract_address", - "client_id", - "chain_id", - "organisation_id", - "enabled" - ] - } - ] - }, - "UpsertSessionActivityContractResp": { - "allOf": [ - { - "$ref": "#/components/schemas/SessionActivityContract" - }, - { - "type": "object" - } - ] - }, - "SessionActivityContract": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The unique identifier of the session activity contract", - "example": 1 - }, - "name": { - "type": "string", - "description": "The name of the session activity contract", - "example": "Session Activity Contract 1" - }, - "contract_address": { - "type": "string", - "description": "The smart contract address", - "pattern": "^0x[0-9a-fA-F]{40}$", - "minLength": 42, - "maxLength": 42, - "example": "0x1234567890abcdef1234567890abcdef12345678" - }, - "client_id": { - "type": "string", - "description": "The client ID associated with the session activity contract", - "pattern": "^[a-zA-Z0-9]{32}$", - "minLength": 32, - "maxLength": 32, - "example": "ZabAMafQRA9bWE1XatAtBYNe6DRamgqE" - }, - "chain_id": { - "type": "string", - "description": "The chain ID for the session activity contract", - "example": "eip155:13371" - }, - "organisation_id": { - "type": "string", - "format": "uuid", - "description": "The organisation ID that owns this session activity contract (UUID format)", - "example": "550e8400-e29b-41d4-a716-446655440000" - }, - "enabled": { - "type": "boolean", - "description": "Whether the session activity contract is enabled", - "example": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "The timestamp when the session activity contract was created", - "example": "2023-12-07T10:30:00Z" - } - } - }, "APIError422": { "allOf": [ {