Read Commands

From TNS API
Jump to: navigation, search

Definition

Read Commands are one of several categories of commands that the TNS Digital Names API makes available to software developers. The API commands within this grouping are characterized by providing access to information that is immutable by the user. The data is purely for display purposes and no new data can be inserted into the application's database via the Read Command being used.

Listing of Read Commands

Command Name Command Line Return Notes
Digital Name Lookup https://usa.tnsapi.cloud/call.cfm?apikey=**&command=namelookup&DigitalName=** 0 = Digital Name is Available
1 = Digital Name is Taken
5 = Digital Name is listed for sale
Command: namelookup * required attribute DigitalName
List All Digital Names Owned By User https://usa.tnsapi.cloud/call.cfm?apikey=**&command=listnames&cc=**&display=html List of digital names owned by user is returned Optional attribute display (display = JSON or HTML)
Public Key Lookup https://usa.tnsapi.cloud/call.cfm?apikey=**&command=keylookup&DigitalName=** 30 = Access to command denied
31 = No Digital Name
Successful return is the public key.
Command: keylookup * required attribute DigitalName.symbol
List All Active Public Keys https://usa.tnsapi.cloud/call.cfm?apikey=**&command=namekeylist&display=JSON&digitalname=** Public keys are returned. Can be returned as JSON or HTML Command: namekeylist * required attribute DigitalName optional attribute display (display = JSON or HTML / type = gateway or currency)
Digital Name Expiration Date https://usa.tnsapi.cloud/call.cfm?apikey=**&command=expdate&DigitalName=** Access to command denied Command: expdate * required attribute DigitalName
List All Active Blockchains https://usa.tnsapi.cloud/call.cfm?apikey=**&command=listcurrency&display=JSON 80 = Access to command denied Command: listcurrency * optional attribute display (display = JSON or HTML)
Digital Names Overview https://usa.tnsapi.cloud/call.cfm?apikey=**&command=overview Centralized overview returned as JSON Command: overview
Digital Names For Sale Categories https://usa.tnsapi.cloud/call.cfm?apikey=**&command=sellcats list of categories returned as JSON Command: sellcats * optional attribute display (display = JSON or HTML)
Digital Names For Sale https://usa.tnsapi.cloud/call.cfm?apikey=**&command=listforsale List of Digital Names for sale on marketplace returned as JSON Command: listforsale * optional attribute display (display = JSON or HTML)