Created
June 21, 2024 10:48
-
-
Save desimmons/1e7e52bf46ee2ddb4e71ecf44ff7e44e to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.1.0", | |
| "info": { | |
| "description": "Accesses Bithomp (https://bithomp.com) and XRPL Services (https://xrpl.services/) APIs through Dhali", | |
| "version": "6.6.3", | |
| "title": "XRP Ledger Dhali Apis", | |
| "contact": { | |
| "name": "@dhali_io", | |
| "email": "[email protected]", | |
| "url": "https://twitter.com/dhali_io" | |
| } | |
| }, | |
| "servers": [ | |
| { | |
| "url": "https://run.api.dhali.io" | |
| } | |
| ], | |
| "tags": [ | |
| { | |
| "name": "NFT Methods" | |
| }, | |
| { | |
| "name": "Offer Methods" | |
| } | |
| ], | |
| "x-tagGroups": [ | |
| { | |
| "name": "General", | |
| "tags": [ | |
| "NFT Methods", | |
| "Offer Methods", | |
| "Funded Status", | |
| "Statistic Methods" | |
| ] | |
| } | |
| ], | |
| "paths": { | |
| "/d995db530-7e57-46d1-ac8a-76324794e0c9/address/{address}": { | |
| "get": { | |
| "summary": "Get username and address information", | |
| "description": "Retrieves a username and other details for a requested XRPL address.", | |
| "operationId": "getAccount", | |
| "parameters": [ | |
| { | |
| "name": "address", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "The XRPL address, can be r-address or X-address" | |
| }, | |
| { | |
| "name": "username", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| }, | |
| "description": "If set to true, the result will include a username." | |
| }, | |
| { | |
| "name": "service", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| }, | |
| "description": "If set to true, the result will include service details." | |
| }, | |
| { | |
| "name": "verifiedDomain", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| }, | |
| "description": "If set true, the result will include a verified domain if such exists." | |
| }, | |
| { | |
| "name": "inception", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| }, | |
| "description": "If set to true, the result will include inception details." | |
| }, | |
| { | |
| "name": "ledgerInfo", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| }, | |
| "description": "If set to true, the result will include ledger info." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully retrieved address information", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "address": { | |
| "type": "string" | |
| }, | |
| "xAddress": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "domain": { | |
| "type": "string" | |
| }, | |
| "socialAccounts": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "verifiedDomain": { | |
| "type": "string" | |
| }, | |
| "inception": { | |
| "type": "integer" | |
| }, | |
| "initialBalance": { | |
| "type": "integer" | |
| }, | |
| "genesis": { | |
| "type": "boolean" | |
| }, | |
| "ledgerInfo": { | |
| "type": "object", | |
| "properties": { | |
| "activated": { | |
| "type": "boolean" | |
| }, | |
| "error": { | |
| "type": "string" | |
| }, | |
| "ledger": { | |
| "type": "integer" | |
| }, | |
| "ledgerTimestamp": { | |
| "type": "integer" | |
| }, | |
| "balance": { | |
| "type": "string" | |
| }, | |
| "flags": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "ownerCount": { | |
| "type": "integer" | |
| }, | |
| "previousTxnID": { | |
| "type": "string" | |
| }, | |
| "previousTxnLgrSeq": { | |
| "type": "integer" | |
| }, | |
| "sequence": { | |
| "type": "integer" | |
| }, | |
| "accountTxnID": { | |
| "type": "string" | |
| }, | |
| "mintedTokens": { | |
| "type": "integer" | |
| }, | |
| "burnedTokens": { | |
| "type": "integer" | |
| }, | |
| "regularKey": { | |
| "type": "string" | |
| }, | |
| "ticketCount": { | |
| "type": "integer" | |
| }, | |
| "signerList": { | |
| "type": "object", | |
| "properties": { | |
| "previousTxnID": { | |
| "type": "string" | |
| }, | |
| "previousTxnLgrSeq": { | |
| "type": "integer" | |
| }, | |
| "signerQuorum": { | |
| "type": "integer" | |
| }, | |
| "flags": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "signerEntries": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "type": "string" | |
| }, | |
| "signerWeight": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "domain": { | |
| "type": "string" | |
| }, | |
| "emailHash": { | |
| "type": "string" | |
| }, | |
| "messageKey": { | |
| "type": "string" | |
| }, | |
| "tickSize": { | |
| "type": "integer" | |
| }, | |
| "transferRate": { | |
| "type": "number" | |
| }, | |
| "blackholed": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d995db530-7e57-46d1-ac8a-76324794e0c9/amms": { | |
| "get": { | |
| "summary": "Get AMMs", | |
| "description": "Returns a list of AMM pools.", | |
| "operationId": "getAMMs", | |
| "parameters": [ | |
| { | |
| "name": "order", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Order of returned AMMs (createdOld, createdNew, updatedOld, updatedNew)" | |
| }, | |
| { | |
| "name": "sortCurrency", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Currency to sort by (when order is currencyHigh)" | |
| }, | |
| { | |
| "name": "sortCurrencyIssuer", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Currency issuer for sortCurrency" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully retrieved AMM pools", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "order": { | |
| "type": "string" | |
| }, | |
| "marker": { | |
| "type": "string" | |
| }, | |
| "amms": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "ammID": { | |
| "type": "string" | |
| }, | |
| "createdAt": { | |
| "type": "integer" | |
| }, | |
| "createdLedgerIndex": { | |
| "type": "integer" | |
| }, | |
| "createdTxHash": { | |
| "type": "string" | |
| }, | |
| "updatedAt": { | |
| "type": "integer" | |
| }, | |
| "updatedLedgerIndex": { | |
| "type": "integer" | |
| }, | |
| "updatedTxHash": { | |
| "type": "string" | |
| }, | |
| "account": { | |
| "type": "string" | |
| }, | |
| "accountDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ownerNode": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "string" | |
| }, | |
| "amount2": { | |
| "type": "object", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "issuerDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tradingFee": { | |
| "type": "integer" | |
| }, | |
| "auctionSlot": { | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "type": "string" | |
| }, | |
| "accountDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "discountedFee": { | |
| "type": "integer" | |
| }, | |
| "expiration": { | |
| "type": "integer" | |
| }, | |
| "price": { | |
| "type": "object", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "issuerDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "lpTokenBalance": { | |
| "type": "object", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "issuerDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "voteSlots": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "createdAt": { | |
| "type": "integer" | |
| }, | |
| "createdLedgerIndex": { | |
| "type": "integer" | |
| }, | |
| "createdTxHash": { | |
| "type": "string" | |
| }, | |
| "updatedAt": { | |
| "type": "integer" | |
| }, | |
| "updatedLedgerIndex": { | |
| "type": "integer" | |
| }, | |
| "updatedTxHash": { | |
| "type": "string" | |
| }, | |
| "account": { | |
| "type": "string" | |
| }, | |
| "accountDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "tradingFee": { | |
| "type": "integer" | |
| }, | |
| "voteWeight": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d995db530-7e57-46d1-ac8a-76324794e0c9/amm/{id}": { | |
| "get": { | |
| "summary": "Get AMM Pool", | |
| "description": "Retrieves information for a requested AMM pool.", | |
| "operationId": "getPools", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "AMM ID, LP token currency code or AMM account address" | |
| }, | |
| { | |
| "name": "ledgerIndex", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Ledger index" | |
| }, | |
| { | |
| "name": "ledgerTimestamp", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Ledger timestamp" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully retrieved AMM pool information", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "ammID": { | |
| "type": "string" | |
| }, | |
| "createdAt": { | |
| "type": "integer" | |
| }, | |
| "createdLedgerIndex": { | |
| "type": "integer" | |
| }, | |
| "createdTxHash": { | |
| "type": "string" | |
| }, | |
| "updatedAt": { | |
| "type": "integer" | |
| }, | |
| "updatedLedgerIndex": { | |
| "type": "integer" | |
| }, | |
| "updatedTxHash": { | |
| "type": "string" | |
| }, | |
| "account": { | |
| "type": "string" | |
| }, | |
| "accountDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ownerNode": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "string" | |
| }, | |
| "amount2": { | |
| "type": "object", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "issuerDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "tradingFee": { | |
| "type": "integer" | |
| }, | |
| "auctionSlot": { | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "type": "string" | |
| }, | |
| "accountDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "discountedFee": { | |
| "type": "integer" | |
| }, | |
| "expiration": { | |
| "type": "integer" | |
| }, | |
| "price": { | |
| "type": "object", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "issuerDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "lpTokenBalance": { | |
| "type": "object", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "issuerDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "voteSlots": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "createdAt": { | |
| "type": "integer" | |
| }, | |
| "createdLedgerIndex": { | |
| "type": "integer" | |
| }, | |
| "createdTxHash": { | |
| "type": "string" | |
| }, | |
| "updatedAt": { | |
| "type": "integer" | |
| }, | |
| "updatedLedgerIndex": { | |
| "type": "integer" | |
| }, | |
| "updatedTxHash": { | |
| "type": "string" | |
| }, | |
| "account": { | |
| "type": "string" | |
| }, | |
| "accountDetails": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "tradingFee": { | |
| "type": "integer" | |
| }, | |
| "voteWeight": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d995db530-7e57-46d1-ac8a-76324794e0c9/search/{value}": { | |
| "get": { | |
| "summary": "Search for a value", | |
| "description": "Search for a given value (could be address, tx hash, username, etc.).", | |
| "operationId": "getSearch", | |
| "parameters": [ | |
| { | |
| "name": "value", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Search value" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "Type of value to search for (address, username, service, etc.)" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully performed search", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "value": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "result": { | |
| "type": "object", | |
| "properties": { | |
| "address": { | |
| "type": "string" | |
| }, | |
| "transaction": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "domain": { | |
| "type": "string" | |
| }, | |
| "socialAccounts": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d995db530-7e57-46d1-ac8a-76324794e0c9/username/{username}": { | |
| "get": { | |
| "summary": "Get username details", | |
| "description": "Retrieves the account associated with a requested username.", | |
| "operationId": "getUsername", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "description": "The username to look up" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully retrieved username details", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "account": { | |
| "type": "string" | |
| }, | |
| "service": { | |
| "type": "string" | |
| }, | |
| "domain": { | |
| "type": "string" | |
| }, | |
| "domain_verified": { | |
| "type": "boolean" | |
| }, | |
| "created": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/all/issuers": { | |
| "get": { | |
| "operationId": "getIssuers", | |
| "summary": "Get all current Issuers of NFTs", | |
| "description": "Returns an array of XRPL accounts which have currently issued NFTs on the XRP Ledger.", | |
| "tags": [ | |
| "NFT Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `issuers` = Array of all currently known NFToken Issuers", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AllIssuerResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/issuer/{issuer}": { | |
| "get": { | |
| "operationId": "getIssuer", | |
| "summary": "Get all NFTs from a specific Issuer", | |
| "description": "Returns an array of NFTs issued by the given Account", | |
| "tags": [ | |
| "NFT Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "issuer", | |
| "required": true, | |
| "description": "The issuer account you want to get the NFTs for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `nfts` = Array of all NFTs of the given Issuer", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IssuerNftResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/taxon/{issuer}": { | |
| "get": { | |
| "operationId": "getTaxonIssuer", | |
| "summary": "Get all taxons used by a specific Issuer", | |
| "description": "Returns an array of taxons used by the given XRPL account.", | |
| "tags": [ | |
| "NFT Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "issuer", | |
| "required": true, | |
| "description": "The issuer account you want to get the Taxons from.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `taxons` = Array of all currently known Taxons used by the given Issuer", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaxonResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/issuer/{issuer}/taxon/{taxon}": { | |
| "get": { | |
| "operationId": "getTaxonTaxon", | |
| "summary": "Get all NFTs from a specific Issuer and Taxon.", | |
| "description": "Returns an array of NFTs issued by the given Issuer with a specific Taxon. This is helpful to receive NFTs of a specific Collection.", | |
| "tags": [ | |
| "NFT Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "issuer", | |
| "required": true, | |
| "description": "The issuer account you want to get the NFTs for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "path", | |
| "name": "taxon", | |
| "required": true, | |
| "description": "The Taxon that the issuer set when minting the NFTs", | |
| "schema": { | |
| "type": "number" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `nfts` = Array of all NFTs of the given Issuer with the specified Taxon", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IssuerTaxonNftResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/owner/{owner}": { | |
| "get": { | |
| "operationId": "getOwnerOwner", | |
| "summary": "Get all NFTs owned by a specific account", | |
| "description": "Returns an array of NFTs owned by the given Account", | |
| "tags": [ | |
| "NFT Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "owner", | |
| "required": true, | |
| "description": "The owner account you want to get the NFTs for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `nfts` = Array of all NFTs owned by the given XRPL Account", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OwnerNftResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/nft/{nftokenid}": { | |
| "get": { | |
| "operationId": "getNFTTokenID", | |
| "summary": "Get details for a single NFT.", | |
| "description": "Returns a single NFT and its details.", | |
| "tags": [ | |
| "NFT Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "nftokenid", | |
| "required": true, | |
| "description": "The NFTokenID of the NFT you want to get the details for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `nft` = single NFT object for the given NFTokenID", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/NFTDetailResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/uri": { | |
| "post": { | |
| "operationId": "getURI", | |
| "summary": "Get all NFTs with a specific URI", | |
| "description": "Returns an array of NFTs with a specific URI", | |
| "tags": [ | |
| "NFT Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "The URI to search NFTs for.", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "required": [ | |
| "uri" | |
| ], | |
| "properties": { | |
| "uri": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "- `nfts` = Array of all NFTs with the specified URI", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/URINftResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/offers/issuer/{issuer}": { | |
| "get": { | |
| "operationId": "getOffersIssuer", | |
| "summary": "Get all Offers for NFTs from a specific Issuer", | |
| "description": "Returns an array of Offers from NFTs issued by the given Account", | |
| "tags": [ | |
| "Offer Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "issuer", | |
| "required": true, | |
| "description": "The issuer account you want to get the Offers for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `offers` = Array of all Offers for NFTs from the given Issuer", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IssuerOfferResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/offers/issuer/{issuer}/taxon/{taxon}": { | |
| "get": { | |
| "operationId": "getIssuerTaxonTaxon", | |
| "summary": "Get all Offers for NFTs from a specific Issuer and Taxon.", | |
| "description": "Returns an array of Offers for NFTs issued by the given Issuer with a specific Taxon. This is helpful to receive Offers of a specific Collection.", | |
| "tags": [ | |
| "Offer Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "issuer", | |
| "required": true, | |
| "description": "The issuer account you want to get the NFTs for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "path", | |
| "name": "taxon", | |
| "required": true, | |
| "description": "The Taxon that the issuer set when minting the NFTs", | |
| "schema": { | |
| "type": "number" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `offers` = Array of all Offers for NFTs from the given Issuer and the specified Taxon", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IssuerTaxonOfferResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/offers/nftowner/{nftowner}": { | |
| "get": { | |
| "operationId": "getOffersOwner", | |
| "summary": "Get all Offers for NFTs owned by a specific account", | |
| "description": "Returns an array of Offers for NFTs owned by the given Account", | |
| "tags": [ | |
| "Offer Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "nftowner", | |
| "required": true, | |
| "description": "The nft owner account you want to get the Offers for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `offers` = Array of all Offers for NFTs owned by the specified XRPL Account", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/NftOwnerOfferResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/offers/offerowner/{offerowner}": { | |
| "get": { | |
| "operationId": "getOffersOfferOwner", | |
| "summary": "Get all NFT Offers owned by a specific account..", | |
| "description": "Returns ALL NFT Offers owned by a specific account.", | |
| "tags": [ | |
| "Offer Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "offerowner", | |
| "required": true, | |
| "description": "The Offer Owner Account which you want to get the Offers for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `offers` = Array of all Offers created/owned by the given XRPL Account", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OfferOwnerResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/offers/offerdestination/{offerdestination}": { | |
| "get": { | |
| "operationId": "getOffersdestination", | |
| "summary": "Get all NFT Offers of a specific account which is set as `Destination`", | |
| "description": "Returns ALL NFT Offers for a single account which is set as `Destination`.", | |
| "tags": [ | |
| "Offer Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "offerdestination", | |
| "required": true, | |
| "description": "The Offer Destination Account which you want to get the Offers for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `offers` = Array of all Offers where the given XRPL Account is set as `Destination`", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OfferDestinationResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/offers/all/account/{xrplaccount}": { | |
| "get": { | |
| "operationId": "getAccountXRPLAccount", | |
| "summary": "Get all relevant offers for a specific XRP Ledger account.", | |
| "description": "Returns all relevant NFToken offers for a specific XRP Ledger account.", | |
| "tags": [ | |
| "Offer Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "xrplaccount", | |
| "required": true, | |
| "description": "The XRPL Account which you want to get the relevant Offers for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `offers_owned` = Array of all Offers created/owned by the given XRPL Account\n\n- `offers_for_own_nfts` = Array of all Offers for NFTs owned by the specified XRPL Account\n\n- `offers_as_destination` = Array of all Offers where the given XRPL Account is set as `Destination`", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AllAccountOffersResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/offer/id/{offerid}": { | |
| "get": { | |
| "operationId": "getOfferFromID", | |
| "summary": "Get a specifc Offer by its ID.", | |
| "description": "Returns the details for a single Offer.", | |
| "tags": [ | |
| "Offer Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "offerid", | |
| "required": true, | |
| "description": "The OfferID of the Offer you receive.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `offer` = single Offer object for the given OfferID", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/NFTOfferIDResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/offers/nft/{nftokenid}": { | |
| "get": { | |
| "operationId": "getAllOffersForID", | |
| "summary": "Get all Offers for a single NFT.", | |
| "description": "Returns Offers for a single NFT.", | |
| "tags": [ | |
| "Offer Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "nftokenid", | |
| "required": true, | |
| "description": "The NFTokenID of the NFT you want to get the Offers for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `offers` = an Object containing all buy and sell Offers for the given NFTokenID", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/NFTOffersResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/stats/issuer/{issuer}": { | |
| "get": { | |
| "operationId": "getIssuerStats", | |
| "summary": "Get stats about all NFTs from a specific issuer", | |
| "description": "*THIS API ENDPOINT EXCLUDES:*\n\n`- EXPIRED BUY OR SELL OFFERS`\n\n`- BUY OR SELL OFFERS WITH AMOUNT = 0`\n\n`- SELL OFFERS WHERE THE OFFER OWNER IS *NOT* THE NFT OWNER`\n\n\n\nReturns an object containing live statistics about the issuer's NFTs", | |
| "tags": [ | |
| "Statistic Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "issuer", | |
| "required": true, | |
| "description": "The Issuer you want to receive NFT stats for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `nfts` = Total number of NFTs by this Issuer\n\n- `unique_owners` = Number of unique XRPL Accounts owning NFTs by the given Issuer\n\n- `nfts_for_sale` = Number of valid sell offer (see exclusions above) for NFTs of the given Issuer \n\n- `sell_offers` = Total Number of sell offers for NFTs of the given Issuer\n\n- `buy_offers` = Total Number of buy offers for NFTs of the given Issuer\n\n- `floor` = shows lowest SELL offers for ALL available currencies across all Marketplaces including XRPL DEX\n\n- `open_market` = Stats about offers on the `Open Market` (no `Destination` set!). Freely available for everyone\n\n- `market_places` = Stats about offers where an MarketPlace is set as `Destination`. (Can only be accepted by the Marketplace!)\n\n", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CollectionInfoIssuerResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/stats/issuer/{issuer}/taxon/{taxon}": { | |
| "get": { | |
| "operationId": "getIssuerTaxonStats", | |
| "summary": "Get stats about specific NFTs from a specific issuer with the given Taxon", | |
| "description": "*THIS API ENDPOINT EXCLUDES:*\n\n`- EXPIRED BUY OR SELL OFFERS`\n\n`- BUY OR SELL OFFERS WITH AMOUNT = 0`\n\n`- SELL OFFERS WHERE THE OFFER OWNER IS *NOT* THE NFT OWNER`\n\n\n\nReturns an object containing live statistics about the issuer's NFTs with a specific `Taxon` (Collection)", | |
| "tags": [ | |
| "Statistic Methods" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "issuer", | |
| "required": true, | |
| "description": "The Issuer you want to receive NFT stats for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "path", | |
| "name": "taxon", | |
| "required": true, | |
| "description": "The Taxon of the issuer you want to receive NFT stats for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "- `nfts` = Total number of NFTs by this Issuer\n\n- `unique_owners` = Number of unique XRPL Accounts owning NFTs by the given Issuer\n\n- `nfts_for_sale` = Number of valid sell offer (see exclusions above) for NFTs of the given Issuer \n\n- `sell_offers` = Total Number of sell offers for NFTs of the given Issuer\n\n- `buy_offers` = Total Number of buy offers for NFTs of the given Issuer\n\n- `floor` = shows lowest SELL offers for ALL available currencies across all Marketplaces including XRPL DEX\n\n- `open_market` = Stats about offers on the `Open Market` (no `Destination` set!). Freely available for everyone\n\n- `market_places` = Stats about offers where an MarketPlace is set as `Destination`. (Can only be accepted by the Marketplace!)\n\n", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CollectionInfoIssuerResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/funded/offer/{offerid}": { | |
| "get": { | |
| "operationId": "getFundedOfferID", | |
| "summary": "Check if a single offer is actually funded or not.", | |
| "description": "Returns the funded status for a specific offer.\n\n**THIS API ENDPOINT IS ONLY ACCESSIBLE VIA API KEY!**\n\nThis endpoint does not count towards the general rate limiting but has its own rate limits:\n\n`- Tier 1 -> Limit: 20 Requests / Minute`\n\n`- Tier 2 -> Limit: 40 Requests / Minute...", | |
| "tags": [ | |
| "Funded Status" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "offerid", | |
| "required": true, | |
| "description": "The OfferID of the NFT Offer you want to get the funded status for.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns an object containing information about the existence and funded status of a single NFT offer", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OfferFundedResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/d72283974-3929-4ed9-81f2-c837fd1e6cc5/xls20-nfts/funded/offers": { | |
| "post": { | |
| "operationId": "getFundedOffers", | |
| "summary": "Check a batch of offers for its funded status.", | |
| "description": "Returns an array of the funded status for a the given offers.\n\n**THIS API ENDPOINT IS ONLY ACCESSIBLE VIA API KEY!**\n\nThis endpoint does not count towards the general rate limiting but has its own rate limits:\n\n`- Tier 1 -> Limit: 20 Requests / Minute`\n\n`- Tier 2 -> Limit: 40 Requests / Minute...", | |
| "tags": [ | |
| "Funded Status" | |
| ], | |
| "requestBody": { | |
| "description": "A string array of OfferIDs you want to check the status for.\n\n**You can send a maximum of 20 OfferIDs in the array at a time!**", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "required": [ | |
| "offers" | |
| ], | |
| "properties": { | |
| "offers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "- `offers` = an array containing the funded status of all given NFT OfferIDs", | |
| "headers": { | |
| "x-ratelimit-limit": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Maximum number of requests per minute." | |
| }, | |
| "x-ratelimit-remaining": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of remaining requests per minute." | |
| }, | |
| "x-ratelimit-reset": { | |
| "schema": { | |
| "type": "integer" | |
| }, | |
| "description": "Number of seconds until the current rate limit window resets." | |
| } | |
| }, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OffersFundedResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "components": { | |
| "securitySchemes": {}, | |
| "schemas": { | |
| "NFT": { | |
| "type": "object", | |
| "required": [ | |
| "NFTokenID", | |
| "Issuer", | |
| "Owner", | |
| "Taxon", | |
| "Sequence", | |
| "TransferFee" | |
| ], | |
| "properties": { | |
| "NFTokenID": { | |
| "type": "string" | |
| }, | |
| "Issuer": { | |
| "type": "string" | |
| }, | |
| "Owner": { | |
| "type": "string" | |
| }, | |
| "Taxon": { | |
| "type": "number" | |
| }, | |
| "Sequence": { | |
| "type": "number" | |
| }, | |
| "TransferFee": { | |
| "type": "number" | |
| }, | |
| "Flags": { | |
| "type": "number" | |
| }, | |
| "URI": { | |
| "type": "string" | |
| } | |
| }, | |
| "title": "NFT" | |
| }, | |
| "NFTOffer": { | |
| "type": "object", | |
| "required": [ | |
| "Amount", | |
| "Flags", | |
| "NFTokenID", | |
| "Owner", | |
| "OfferID" | |
| ], | |
| "properties": { | |
| "Amount": { | |
| "oneOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| ] | |
| }, | |
| "Flags": { | |
| "type": "number" | |
| }, | |
| "NFTokenID": { | |
| "type": "string" | |
| }, | |
| "Owner": { | |
| "type": "string" | |
| }, | |
| "OfferID": { | |
| "type": "string" | |
| }, | |
| "Destination": { | |
| "type": "string" | |
| }, | |
| "Expiration": { | |
| "type": "number" | |
| } | |
| }, | |
| "title": "NFTOffer" | |
| }, | |
| "NFTOfferData": { | |
| "type": "object", | |
| "required": [ | |
| "NFTokenID", | |
| "NFTokenOwner", | |
| "URI", | |
| "buy", | |
| "sell" | |
| ], | |
| "properties": { | |
| "NFTokenID": { | |
| "type": "string" | |
| }, | |
| "NFTokenOwner": { | |
| "type": "string" | |
| }, | |
| "URI": { | |
| "type": "string" | |
| }, | |
| "buy": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOffer" | |
| } | |
| }, | |
| "sell": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOffer" | |
| } | |
| } | |
| }, | |
| "title": "NFTOfferData" | |
| }, | |
| "Info": { | |
| "type": "object", | |
| "required": [ | |
| "ledger_index", | |
| "ledger_hash", | |
| "ledger_close", | |
| "ledger_close_ms" | |
| ], | |
| "properties": { | |
| "ledger_index": { | |
| "type": "number" | |
| }, | |
| "ledger_hash": { | |
| "type": "string" | |
| }, | |
| "ledger_close": { | |
| "type": "string" | |
| }, | |
| "ledger_close_ms": { | |
| "type": "number" | |
| } | |
| }, | |
| "title": "Info" | |
| }, | |
| "FloorPriceProperty": { | |
| "type": "object", | |
| "required": [ | |
| "issuer", | |
| "currency", | |
| "amount" | |
| ], | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "number" | |
| } | |
| }, | |
| "title": "FloorPriceProperty" | |
| }, | |
| "CollectionInfoData": { | |
| "type": "object", | |
| "required": [ | |
| "issuer", | |
| "taxon", | |
| "nfts", | |
| "unique_owners", | |
| "nfts_for_sale", | |
| "sell_offers", | |
| "buy_offers", | |
| "floor" | |
| ], | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "taxon": { | |
| "type": "string" | |
| }, | |
| "nfts": { | |
| "type": "number" | |
| }, | |
| "unique_owners": { | |
| "type": "number" | |
| }, | |
| "nfts_for_sale": { | |
| "type": "number" | |
| }, | |
| "sell_offers": { | |
| "type": "number" | |
| }, | |
| "buy_offers": { | |
| "type": "number" | |
| }, | |
| "floor": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/FloorPriceProperty" | |
| } | |
| }, | |
| "open_market": { | |
| "type": "object", | |
| "required": [ | |
| "nfts_for_sale", | |
| "sell_offers", | |
| "buy_offers", | |
| "floor" | |
| ], | |
| "properties": { | |
| "nfts_for_sale": { | |
| "type": "number" | |
| }, | |
| "sell_offers": { | |
| "type": "number" | |
| }, | |
| "buy_offers": { | |
| "type": "number" | |
| }, | |
| "floor": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/FloorPriceProperty" | |
| } | |
| } | |
| } | |
| }, | |
| "market_places": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/MpData" | |
| } | |
| } | |
| }, | |
| "title": "CollectionInfoData" | |
| }, | |
| "MpData": { | |
| "type": "object", | |
| "required": [ | |
| "mp_account", | |
| "nfts_for_sale", | |
| "sell_offers", | |
| "buy_offers", | |
| "floor" | |
| ], | |
| "properties": { | |
| "mp_account": { | |
| "type": "string" | |
| }, | |
| "nfts_for_sale": { | |
| "type": "number" | |
| }, | |
| "sell_offers": { | |
| "type": "number" | |
| }, | |
| "buy_offers": { | |
| "type": "number" | |
| }, | |
| "floor": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/FloorPriceProperty" | |
| } | |
| } | |
| }, | |
| "title": "MpData" | |
| }, | |
| "OfferFundedSingleData": { | |
| "type": "object", | |
| "required": [ | |
| "offerid", | |
| "funded", | |
| "exists" | |
| ], | |
| "properties": { | |
| "offerid": { | |
| "type": "string" | |
| }, | |
| "funded": { | |
| "type": "boolean" | |
| }, | |
| "exists": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "AllIssuerResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/AllIssuerData" | |
| } | |
| }, | |
| "title": "All Issuers Respnse" | |
| }, | |
| "AllIssuerData": { | |
| "type": "object", | |
| "required": [ | |
| "issuers" | |
| ], | |
| "properties": { | |
| "issuers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "TaxonResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/TaxonData" | |
| } | |
| }, | |
| "title": "Taxon Response" | |
| }, | |
| "TaxonData": { | |
| "type": "object", | |
| "required": [ | |
| "issuer", | |
| "taxons" | |
| ], | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "taxons": { | |
| "type": "array", | |
| "items": { | |
| "type": "number" | |
| } | |
| } | |
| } | |
| }, | |
| "IssuerNftResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/IssuerNftData" | |
| } | |
| }, | |
| "title": "Issuer NFT Response" | |
| }, | |
| "IssuerNftData": { | |
| "type": "object", | |
| "required": [ | |
| "issuer", | |
| "nfts" | |
| ], | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "nfts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFT" | |
| } | |
| } | |
| } | |
| }, | |
| "IssuerTaxonNftResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/IssuerTaxonNftData" | |
| } | |
| }, | |
| "title": "Issuer Taxon NFT Response" | |
| }, | |
| "IssuerTaxonNftData": { | |
| "type": "object", | |
| "required": [ | |
| "issuer", | |
| "taxon", | |
| "nfts" | |
| ], | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "taxon": { | |
| "type": "number" | |
| }, | |
| "nfts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFT" | |
| } | |
| } | |
| } | |
| }, | |
| "OwnerNftResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/OwnerNftData" | |
| } | |
| }, | |
| "title": "NFT Owner Response" | |
| }, | |
| "OwnerNftData": { | |
| "type": "object", | |
| "required": [ | |
| "owner", | |
| "nfts" | |
| ], | |
| "properties": { | |
| "owner": { | |
| "type": "string" | |
| }, | |
| "nfts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFT" | |
| } | |
| } | |
| } | |
| }, | |
| "URINftResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/URINftData" | |
| } | |
| }, | |
| "title": "NFT URI Response" | |
| }, | |
| "URINftData": { | |
| "type": "object", | |
| "required": [ | |
| "uri", | |
| "nfts" | |
| ], | |
| "properties": { | |
| "uri": { | |
| "type": "string" | |
| }, | |
| "nfts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFT" | |
| } | |
| } | |
| } | |
| }, | |
| "NFTDetailResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/NFTDetailData" | |
| } | |
| }, | |
| "title": "NFT Detail Response" | |
| }, | |
| "NFTDetailData": { | |
| "type": "object", | |
| "required": [ | |
| "nft" | |
| ], | |
| "properties": { | |
| "nft": { | |
| "$ref": "#/components/schemas/NFT" | |
| } | |
| } | |
| }, | |
| "IssuerOfferResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/IssuerOfferData" | |
| } | |
| }, | |
| "title": "Issuer Offer Response" | |
| }, | |
| "IssuerOfferData": { | |
| "type": "object", | |
| "required": [ | |
| "issuer", | |
| "offers" | |
| ], | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "offers": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOfferData" | |
| } | |
| } | |
| } | |
| }, | |
| "IssuerTaxonOfferResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/IssuerTaxonOfferData" | |
| } | |
| }, | |
| "title": "Issuer Taxon Offer Response" | |
| }, | |
| "IssuerTaxonOfferData": { | |
| "type": "object", | |
| "required": [ | |
| "issuer", | |
| "taxon", | |
| "offers" | |
| ], | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "taxon": { | |
| "type": "number" | |
| }, | |
| "offers": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOfferData" | |
| } | |
| } | |
| } | |
| }, | |
| "NftOwnerOfferResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/NftOwnerOfferData" | |
| } | |
| }, | |
| "title": "NFT Owner Offer Response" | |
| }, | |
| "NftOwnerOfferData": { | |
| "type": "object", | |
| "required": [ | |
| "nftowner", | |
| "offers" | |
| ], | |
| "properties": { | |
| "nftowner": { | |
| "type": "string" | |
| }, | |
| "offers": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOfferData" | |
| } | |
| } | |
| } | |
| }, | |
| "NFTOffersResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/NFTOffersData" | |
| } | |
| }, | |
| "title": "NFT Offers Response" | |
| }, | |
| "NFTOffersData": { | |
| "type": "object", | |
| "required": [ | |
| "nftokenid", | |
| "offers" | |
| ], | |
| "properties": { | |
| "nftokenid": { | |
| "type": "string" | |
| }, | |
| "offers": { | |
| "$ref": "#/components/schemas/NFTOfferData" | |
| } | |
| } | |
| }, | |
| "OfferFundedResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/OfferFundedData" | |
| } | |
| }, | |
| "title": "Offer Funded Response" | |
| }, | |
| "OfferFundedData": { | |
| "type": "object", | |
| "required": [ | |
| "offerid", | |
| "funded", | |
| "exists" | |
| ], | |
| "properties": { | |
| "offerid": { | |
| "type": "string" | |
| }, | |
| "funded": { | |
| "type": "boolean" | |
| }, | |
| "exists": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "OffersFundedResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/OffersFundedData" | |
| } | |
| }, | |
| "title": "Offers Funded Response" | |
| }, | |
| "OffersFundedData": { | |
| "type": "object", | |
| "required": [ | |
| "offers" | |
| ], | |
| "properties": { | |
| "offers": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/OfferFundedSingleData" | |
| } | |
| } | |
| } | |
| }, | |
| "NFTOfferIDResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/NFTOfferIDData" | |
| } | |
| }, | |
| "title": "NFT OfferID Response" | |
| }, | |
| "NFTOfferIDData": { | |
| "type": "object", | |
| "required": [ | |
| "offerid", | |
| "offer" | |
| ], | |
| "properties": { | |
| "offerid": { | |
| "type": "string" | |
| }, | |
| "offer": { | |
| "$ref": "#/components/schemas/NFTOffer" | |
| } | |
| } | |
| }, | |
| "OfferOwnerResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/OfferOwnerData" | |
| } | |
| }, | |
| "title": "Offer Owner Response" | |
| }, | |
| "OfferOwnerData": { | |
| "type": "object", | |
| "required": [ | |
| "offerowner", | |
| "offers" | |
| ], | |
| "properties": { | |
| "offerowner": { | |
| "type": "string" | |
| }, | |
| "offers": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOffer" | |
| } | |
| } | |
| } | |
| }, | |
| "OfferDestinationResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/OfferDestinationData" | |
| } | |
| }, | |
| "title": "Offer Destination Response" | |
| }, | |
| "OfferDestinationData": { | |
| "type": "object", | |
| "required": [ | |
| "offerdestination", | |
| "offers" | |
| ], | |
| "properties": { | |
| "offerdestination": { | |
| "type": "string" | |
| }, | |
| "offers": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOffer" | |
| } | |
| } | |
| } | |
| }, | |
| "AllAccountOffersResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/AllAccountOffersData" | |
| } | |
| }, | |
| "title": "All Account Offers Response" | |
| }, | |
| "AllAccountOffersData": { | |
| "type": "object", | |
| "required": [ | |
| "xrplaccount", | |
| "offers_owned", | |
| "offers_for_own_nfts" | |
| ], | |
| "properties": { | |
| "xrplaccount": { | |
| "type": "string" | |
| }, | |
| "offers_owned": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOffer" | |
| } | |
| }, | |
| "offers_for_own_nfts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOfferData" | |
| } | |
| }, | |
| "offers_as_destination": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/NFTOffer" | |
| } | |
| } | |
| } | |
| }, | |
| "CollectionInfoIssuerResponse": { | |
| "type": "object", | |
| "required": [ | |
| "info", | |
| "data" | |
| ], | |
| "properties": { | |
| "info": { | |
| "$ref": "#/components/schemas/Info" | |
| }, | |
| "data": { | |
| "$ref": "#/components/schemas/CollectionInfoData" | |
| } | |
| }, | |
| "title": "CollectionInfoIssuerResponse" | |
| }, | |
| "CollectionInfoIssuerData": { | |
| "type": "object", | |
| "required": [ | |
| "issuer", | |
| "collection_info" | |
| ], | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "collection_info": { | |
| "$ref": "#/components/schemas/CollectionInfoData" | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": { | |
| "limit": { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Limit the entries in the response." | |
| }, | |
| "skip": { | |
| "name": "skip", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| }, | |
| "description": "Skip a defined number of entries." | |
| } | |
| }, | |
| "responses": {}, | |
| "requestBodies": {}, | |
| "examples": {} | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment