Search

From ArdorDocs
Jump to: navigation, search

Get Aliases Like

Get all aliases starting with a given prefix in alias name order. Javadoc

Request:

  • requestType is getAliasesLike
  • chain is the chain related to the operation (ie: Ignis)
  • aliasPrefix is the prefix (at least 2 characters long) of the aliasName
  • firstIndex is a zero-based index to the first alias to retrieve (optional)
  • lastIndex is a zero-based index to the last alias to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • aliases (A) is an array of alias objects (refer to Get Alias for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Aliases Like Example

https://localhost:27876/nxt?
  requestType=getAliasesLike&
  chain=2&
  aliasPrefix=mysteri
{
 "aliases": [
  {
   "aliasURI": "",
   "aliasName": "mysteries",
   "accountRS": "ARDOR-9DZL-XFE2-EWE5-HVVAY",
   "alias": "13234331415538245332",
   "account": "18384674354580664306",
   "timestamp": 4856820
  },
  {
   "aliasURI": "anm",
   "aliasName": "mysterious",
   "accountRS": "ARDOR-AHBB-DSVC-WS2L-EW8BC",
   "alias": "8033154744709486670",
   "account": "14205721421835156777",
   "timestamp": 2417903
  }
 ],
 "requestProcessingTime": 1
}


Get DGS Tags Like

Get all tags starting with a given prefix (at least 2 characters long) in reverse inStockCount, reverse totalCount, tag order. Javadoc

Request:

  • requestType is getDGSTagsLike
  • chain the chain related to the operation
  • tagPrefix is the prefix (at least 2 characters long) of the tag
  • inStockOnly is false if out-of-stock tags are to be retrieved (optional)
  • firstIndex is a zero-based index to the first tag to retrieve (optional)
  • lastIndex is a zero-based index to the last tag to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • tags (A) is an array of tag objects with the following fields for each tag:
    • inStockCount (N) is the number of products available for sale as tagged
    • tag (S) is the tag word
    • totalCount (N) is the total number of products as tagged
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Note: The ...Count fields refer to the number of distinct products tagged, regardless of the quantity of each.

Get DGS Tags Like Example

http://localhost:27876/nxt?
  requestType=getDGSTagsLike&
  chain=2&
  tagPrefix=item
{
 "requestProcessingTime": 1,
 "tags": [
  {
   "inStockCount": 1,
   "tag": "items",
   "totalCount": 1
  }
 ]
}


Get Data Tags Like

Prefix search of available data tags, return in alphabetical order. Javadoc

Request:

  • requestType is getDataTagsLike
  • chain the chain related to the operation
  • tagPrefix is the prefix to search for (2 character minimum) among all data tags
  • firstIndex is a zero-based index to the first tag to retrieve (optional)
  • lastIndex is a zero-based index to the last tag to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • tags (A) is an array of tag objects including the fields:
    • tag (S) is a tag word
    • count (N) is the number of uses of tag among all tagged data
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Get Data Tags Like Example

http://localhost:27876/nxt?
  requestType=getDataTagsLike&
  chain=2&
  tagPrefix=con
{
 "requestProcessingTime": 2,
 "tags": [
  {
   "count": 3,
   "tag": "contract"
  },
  {
   "count": 1,
   "tag": "contracts"
  }
 ]
}


Search Accounts

Get accounts having a name or description that match a given query in reverse relevance order. Javadoc

Request:

  • requestType is searchAccounts
  • query is a full text query on the account fields name (S) and description (S) in the standard Lucene syntax
  • firstIndex is a zero-based index to the first account to retrieve (optional)
  • lastIndex is a zero-based index to the last account to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • accounts (A) is an array of account objects with the following fields:
    • account (S) is the account number
    • accountRS (S) is the Reed-Solomon address of the account
    • name (S) is the name of the account
    • description (S) is the description of the account (if applicable)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Search Accounts Example

http://localhost:27876/nxt?
  requestType=searchAccounts&
  query=testnet AND tyler
{
 "accounts": [
  {
   "accountRS": "ARDOR-7C4U-3Z9K-GZM8-CU8EJ",
   "name": "Tyler Jordan",
   "description": "testnet account",
   "account": "12119426358687475802"
  }
 ],
 "requestProcessingTime": 16
}


Search Assets

Get assets having a name or description that match a given query in reverse relevance order. Javadoc

Request:

  • requestType is searchAssets
  • query is a full text query on the asset fields name (S) and description (S) in the standard Lucene syntax
  • firstIndex is a zero-based index to the first asset to retrieve (optional)
  • lastIndex is a zero-based index to the last asset to retrieve (optional)
  • includeCounts is true if the fields beginning with numberOf... are to be included (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • assets (A) is an array of asset objects (refer to Get Asset)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Search Assets Example

http://localhost:27876/nxt?
  requestType=searchAssets&
  query=assets AND production
{
 "assets": [
  {
   "quantityQNT": "2100000000000000",
   "numberOfAccounts": 37,
   "accountRS": "ARDOR-3TKA-UH62-478B-DQU6K",
   "decimals": 8,
   "numberOfTransfers": 84,
   "name": "mgwBTC",
   "description": "Production Multigateway BTC (mgwBTC) is backed 100% by...",
   "numberOfTrades": 15,
   "asset": "17554243582654188572",
   "account": "13300069592148796968"
  }
 ],
 "requestProcessingTime": 96
}


Search Currencies

Get currencies having a code that matches a given query in reverse relevance order. Javadoc

Request:

  • requestType is searchCurrencies
  • query is a full text query on the currency field code in the standard Lucene syntax
  • firstIndex is a zero-based index to the first currency to retrieve (optional)
  • lastIndex is a zero-based index to the last currency to retrieve (optional)
  • includeCounts is true if the fields beginning with numberOf... are to be included (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • currencies (A) is an array of currency objects (refer to Get Currency for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Search Currencies Example

http://localhost:27876/nxt?
  requestType=searchCurrencies&
  query=PTNT?
{
 "requestProcessingTime": 5,
 "currencies": [
  {
    "currentReservePerUnitNQT": "0",
    "chain": 2,
    "types": [
     "EXCHANGEABLE"
    ],
    "code": "PTNT",
    "currentSupplyQNT": "100000000",
    "creationHeight": 361192,
    "minDifficulty": 0,
    "description": "Potential coin",
    "minReservePerUnitNQT": "0",
    "initialSupplyQNT": "100000000",
    "issuanceHeight": 0,
    "type": 1,
    "maxSupplyQNT": "100000000",
    "maxDifficulty": 0,
    "accountRS": "ARDOR-X8ZN-WUJ2-SXY3-FBUYC",
    "decimals": 2,
    "name": "POTENTIAL",
    "reserveSupplyQNT": "0",
    "currency": "7978322511509619701",
    "account": "15382970207090678772",
    "algorithm": 0
  }
 ]
}


Search DGS Goods

Get product listings that have a name or description that match a given query in reverse relevance order, then name order (given a seller), then reverse chronological order. Javadoc

Request:

  • requestType is searchDGSGoods
  • chain the chain related to the operation
  • query is a full text query on the goods fields name and description in the standard Lucene syntax (optional)
  • tag is a query on the good field tags in the standard Lucene syntax (optional)
  • seller is the account ID of the product seller (optional)
  • firstIndex is a zero-based index to the first product to retrieve (optional)
  • lastIndex is a zero-based index to the last product to retrieve (optional)
  • inStockOnly is false if out-of-stock products (zero quantity) are to be retrieved (optional)
  • hideDelisted is true if delisted products are to be omitted (optional)
  • includeCounts is true if the fields beginning with numberOf... are to be included (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • goods (A) is an array of goods objects (refer to Get DGS Good for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Search DGS Goods Example

http://localhost:27876/nxt?
  requestType=searchDGSGoods&
  chain=2&
  tag=te?t AND prod*
{
 "goods": [
  {
   "seller": "7580519603555678830",
   "quantity": 1,
   "goods": "1587116104511359906",
   "description": "This is a test. Please do not order.",
   "sellerRS": "ARDOR-6GMG-FC5F-YSX6-8CVEL",
   "delisted": false,
   "parsedTags": [
    "test",
    "product",
    "tag"
   ],
   "tags": "test,product,tag",
   "priceNQT": "100000000",
   "numberOfPublicFeedbacks": 1,
   "name": "Test Product",
   "numberOfPurchases": 1,
   "timestamp": 31611435
  }
 ],
 "requestProcessingTime": 4
}


Search Polls

Search for poll details given a name/description query string. Javadoc

Request:

  • requestType is searchPolls
  • chain the chain related to the operation (eg: IGNIS)
  • query is a full text query on the poll fields name (S) and description (S) in the standard Lucene syntax (optional)
  • firstIndex is a zero-based index to the first poll to retrieve (optional)
  • lastIndex is a zero-based index to the last poll to retrieve (optional)
  • includeFinished is true to include completed polls (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • polls (A) is an array of polls (refer to Get Poll for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Search Polls Example

http://localhost:27876/nxt?
  requestType=searchPolls&
  chain=2&
  query=hello&
  includeFinished=true
{
 "polls": [
  {
   "minRangeValue": 0,
   "votingModel": 1,
   "description": "Hello World Poll",
   "finished": true,
   "poll": "3043888702585899321",
   "minNumberOfOptions": 1,
   "minBalance": "0",
   "accountRS": "ARDOR-XK4R-7VJU-6EQG-7R335",
   "name": "Poll1",
   "options": [
    "Hello",
    "World"
   ],
   "finishHeight": 255816,
   "maxNumberOfOptions": 1,
   "minBalanceModel": 1,
   "account": "5873880488492319831",
   "maxRangeValue": 1
  }
 ],
 "requestProcessingTime": 3
}


Search Tagged Data

Full text search on available tagged data name, description and tags; optionally filtered by tag, channel or uploading account; return in reverse relevance order. Javadoc

Request:

  • requestType is searchTaggedData
  • chain the chain related to the operation
  • query is a full text query on the metadata fields name (S), description (S) and tags (S) in the standard Lucene syntax
  • tag is a word in the tags string (optional)
  • channel is a channel string (optional)
  • account is an account ID (optional)
  • includeData is true to include data (optional)
  • adminPassword [[API#Admin_Password|Admin password parameter (optional)
  • firstIndex is a zero-based index to the first tagged data to retrieve (optional)
  • lastIndex is a zero-based index to the last tagged data to retrieve (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • data (A) is an array of tagged data objects (refer to Get Tagged Data with hash omitted for details)
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)

Search Tagged Data Example

http://localhost:27876/nxt?
  requestType=searchTaggedData&
  chain=2&
  query=SG?&
  lastIndex=0
{
 "data": [
  {
   "data": "d4f167249340d6d746f49441b8ccdb1bd3521feb",
   "channel": "torrent",
   "description": "Hash of the torrent.",
   "type": "",
   "parsedTags": [
    "video",
    "scifi",
    "torrent"
   ],
   "transactionTimestamp": 47843875,
   "tags": "video, scifi, torrent",
   "filename": "",
   "accountRS": "ARDOR-4VDY-LNVT-LMAY-FMCKA",
   "name": "Stargate SG1 full series",
   "blockTimestamp": 47672045,
   "transaction": "9086193976300572942",
   "account": "15295723609781267838",
   "isText": true
  }
 ],
 "requestProcessingTime": 22
}