TrxSys Blockchain API and SDK

Updated: March 30, 2021

While many TrxSys users find that the built in graphical or presentation layer for Chain Apps is sufficient for their use others will require access to TrxSys from their own applications. TrxSys provides an API to submit and query both transactions and Chain Apps.

API... Application Programming Interface

SDK... Software Development Kit

The following examples are in Python (v3) but should suffice to demonstrate in other languages as well.

Submit a transaction to TrxSys using API

A transaction is the most basic unit of data within TrxSys. However, a transaction is extremely flexible and can support a wide range of functions (i.e.types of transactions) as well as large data sets within the message field of a transaction.

API Example: Submit a transaction

### send_simple_trx_to_api.py
### Robert Lawson Vaughn
### May 18, 2020
### Description:
### Program is used to send transaction to TrxSys via API post
### Copyright 2020 TrxSys.com 

### Import modules
import requests
import base64
import json


### Set URL to point to API
URL = "https://trxsys.com/transaction_exec.pl"

### Set values
lg_name = "your_username"
lg_password = "your_password"

sender_amount = "0"
	## Refers to an amount of TrxSys cryptocurrency
	## Default is 0

sender_message = "This is a test API message to TrxSys from Python 05262020 test b"
	## Is an optional field

recipient_pid = "0"
	## Is an optional field
	## Only one recipient_pid can be entered
	
sender_chain_id = "0"
	## Is optional.  Should be used if transaction is part of a set or chain app.  Used to prove the wholeness of a data set.

sender_add_to_public_index = "0"
	## Is an optional field
	## No or 0 (or NULL or empty) = default, do not allow this transaction to be publicly discoverable.  If a chain template then this setting allows the chain template to be publicly found but not the transactions.
	## Yes or 1 = add to public index, allows transaction to be publicly listed, searched, discoverable.  If a chain template then this setting allows the chain template to be publicly found and the transactions.


sender_transaction_type = "3"
	## Is an optional field.  
	## Default is "3" 
	## "3" is a standard transaction with or without a recipient.


### The sender_message must be converted to Base64.
sender_message_base64 = base64.b64encode( bytes(sender_message, "utf-8") )
sender_message_base64_utf8 = (sender_message_base64.decode("utf-8"))


### Create post_data.  This is the entire message that gets sent to the TrxSys API
post_data = (f"{{"
			f"\"lg_name\":\"{lg_name}\","
			f"\"lg_password\":\"{lg_password}\","
			f"\"sender_amount\":\"{sender_amount}\","
			f"\"sender_message_base64\":\"{sender_message_base64_utf8}\","
			f"\"recipient_pid\":\"{recipient_pid}\","
			f"\"sender_chain_id\":\"{sender_chain_id}\","
			f"\"sender_add_to_public_index\":\"{sender_add_to_public_index}\","
			f"\"sender_transaction_type\":\"{sender_transaction_type}\""
			f"}}")

print (post_data) #optional

### Set headers to be included in message
headers = {'content-type': 'application/json'}

### Post message to TrxSys API
r = requests.post(url = URL, data=post_data, headers=headers)

### Display results from TrxSys API
print (r.text)

The above example Python (v3) code demonstrates how to send a transaction to the TrxSys API.

API Example: Submit a transaction results

C:\python\scripts>send_simple_trx_to_api.py {"lg_name":"your_username","lg_password":"your_password","sender_amount":"0","sender_message_base64":"VGhpcyBpcyBhIHRlc3QgQVBJIG1lc3NhZ2UgdG8gVHJ4U3lzIGZyb20gUHl0aG9uIDA1MjYyMDIwIHRlc3QgYg==","recipient_pid":"0","sender_add_to_public_index":"0","sender_transaction_type":"3"} debug=on 200 OK {"object":"sender","sender_version":"","sender_transaction_type":"3","sender_timestamp_l_g":"1590522261","sender_amount":"0","sender_type":"1","sender_pid":"0123456789012345678901234567890123456789012345678901","sender_message":"7d12bf5ad21cb450ea3a1ea32d14ab9277fe8ba8bac99bc8cbc809affa988775ad2ad19e5d3d25b0bf6df97419203c484b972b7213cce843230f2f3df029697fb5416884d658b9d509c08b2c053d1492cb177c42830eb3fadf16b944d158e1e2","sender_message_key_url":"","sender_encrypt_transaction":"0","sender_add_to_public_index":"0","sender_public_alias":"","sender_message_encoding":"","sender_chain_id":"","sender_chain_id_remove":"","sender_chain_common_name":"","sender_chain_acl_add_id":"","sender_chain_acl_remove_id":"","sender_chain_acl_promote_id":"","sender_random_id":"","sender_chain_keywords":"","authoritative_domain":""}{"object":"sendersigning","sendersigning_hash_of_sender_objects":"a8bd36946bae1190c61ea107e14f9c7e3a5682f845ab1560eb4392229631f19d","sendersigning_hash_of_sender_objects_signature_hex":"3045022100a67db074440d450aeff6b8d647a0262bc80f8e7025e1f7b360b9deb84a5ab73902203b2f704cb1ea0b8c38ece80c6a6875e97497ec309f69ff196be551c1f415ade1","sendersigning_sender_pkp_public_key":"-----BEGIN PUBLIC KEY-----MIH1MIGuBgcqhkjOPQIBMIGiAgEBMCwGByqGSM49AQECIQD////////////////////////////////////+///8LzAGBAEABAEHBEEEeb5mfvncu6xVoGKVzocLBwKb/NstzijZWfKBWxb4F5hIOtp3JqPEZV2k+/wOEQio/Re0SKaFVBmcR9CP+xDUuAIhAP////////////////////66rtzmr0igO7/SXozQNkFBAgEBA0IABLd3GBV7zdZ66I12H8hFjwKD0GO3n4fyK4882UMAoiGPHQ8dumlQPVsRzE7yaNQEsrr604WM1SOwHElB0vIbLzs=-----END PUBLIC KEY-----"}{"object":"recipient","recipient_pid":"0","recipient_random_id":""}{"object":"recipientsigning","recipientsigning_hash_of_recipient_objects":"","recipientsigning_hash_of_recipient_objects_signature_hex":"","recipientsigning_recipient_pkp_public_key":""}{"object":"xnode","xnode_prior_record_block_hash":"8a0f40c9cf8fd1a5f2f2c33015ef2594a20df619ec5d71cf1e9c77523337a48c","xnode_sequential_transaction_id":"142","xnode_timestamp_l_g":"1590522261","xnode_fee":"0.0002","xnode_governor_meta_data":"","xnode_pid_governor":"0123456789012345678901234567890123456789012345678901","xnode_transaction_id":"y1yIJQXpXqbWMHMgkSYdDWGe9ErpvclRhiWqQICunpBY21z1LAJv"}{"object":"blocksigning","blocksigning_hash_of_all_objects":"c397a0948394725054ca6d0a26b42f3db683106fcba0f71e50d5b7367081bcfa","blocksigning_hash_of_all_objects_signature_hex":"30440220487c8973f4b8721eeb99a4c2e40d62164aa3dab55d62e31105559b5509eb166602205a30698db71b7a04efff2fa83e16b19ccba738e8f1b2c66b9987ca5dcda59f81","blocksigning_gov_pub_key":"-----BEGIN PUBLIC KEY-----MIH1MIGuBgcqhkjOPQIBMIGiAgEBMCwGByqGSM49AQECIQD////////////////////////////////////+///8LzAGBAEABAEHBEEEeb5mfvncu6xVoGKVzocLBwKb/NstzijZWfKBWxb4F5hIOtp3JqPEZV2k+/wOEQio/Re0SKaFVBmcR9CP+xDUuAIhAP////////////////////66rtzmr0igO7/SXozQNkFBAgEBA0IABI8Cs7hXNyXooEOSIasg6rIYbmeDPRkAcOCIFmPkb6NxDDb6arn9AcZZDb6FpxF1Q1aCw/IJAgMGxI58HlODyOY=-----END PUBLIC KEY-----"}{"object":"chainribbon","chainribbon_key":"e40KtKcVCT9R0V8TGYCEr6IOy5rctW5T","chainribbon_iv":"fH9rIniMvK3gpaYd"}

The above example Python (v3) code demonstrates the results from a transaction sent to the TrxSys API.

Viewing a Transaction Example

The above example screenshot from My Account shows how a message was recorded on the TrxSys blockchain.

To learn more about the TrxSys transaction and its parts, visit Understanding the TrxSys Transaction

Query a TrxSys transaction using API

API Example: Query a transaction

### query_consolidated.py

### Robert Lawson Vaughn
### March 28, 2021
### Description:
### Program is used to query transactions by transaction ID, Chain App ID or collections of IDs from TrxSys via API
### Copyright 2021 TrxSys.com 

### Import modules
import requests
import base64
import json



### Set URL to point to API

URL = "https://trxsys.com/api/consolidated_query.pl"



### Set credentials values
lg_name = ""
lg_password = ""

### Optionally read credentials values from a file
# fileh = open ("credentials.txt")
# credentials = fileh.readlines
# lg_password = fileh.readline()
# lg_password = lg_password.strip('\n')


entry_type = "api"
	## Is required, no other to options.  Set to "api"
	
	
id_type = "1"
	## Is a required field
	## "1" query a single transaction ID or a collection of transaction IDs comma separated
	## "2" query a single chain ID or a collection of chain IDs comma separated
	## Do not mix transaction IDs and chain IDs.


query_type = "6"
	## Is a required field
	## "1" query transaction and return full transaction including decrypt message
	## "2" query transaction and return full transaction do not decrypt message
	## "3" query transaction but do not return message (because it could be really large)
	## "4" query transaction but only return transaction size (sender_message_size)
	## "5" binary responds with true if user has rights to the transaction, otherwise false if user does not have rights.
	## "6" query transaction(s) and return decrypted message, xnode_transaction)id, sender_chain_id, xnode_timestamp_l_g, sender_pid, recipient_pid
	

### Specify the type of transactions to include in the query
transaction_types = ""
	## Is an optional field, examples
	## "3" is a standard transaction
	## "4" is a transaction with data formatted to a chain app template
	## Multiple transaction types can be included comma separated 


 ### Specify time range to return results.  
timestart_epoch = "0" ## Is the older value
timestop_epoch = "0" ## Is the newer value
	## Are optional fields.  Use either, both or neither.
	## Is formatted as epoch.
	## Transactions outside of the specified range will not be included in the results set.
	## Set to "0" to not set a limit
	
display_rights_analysis = "no"
	## Is an optional field.  Defaults to "no"
	## "yes" displays transaction rights analysis
	## "no" 
	
	
echo_mode = "no"
	## Is an optional field.  Defaults to "yes"
	## "yes" echos back parameters sent to API
	## "no" does not echo back parameters sent to API
	
debug_mode = "no"
	## Is an optional field.  Defaults to "no"
	## "yes" echos back additional data on request processing
	## "no" does not display additional data
	


### If multiple IDs should be comma separated.  Do not mix chain ID with transaction IDs.  One or the other.
# fileids = open ("ids.txt")
# ids_file = fileids.readlines
# ids = fileids.readline()
# ids = ids.strip('\n')
#ids = "F0zrzuLyjASednvXwZU1o0N1RlwKeXeq1XpIihESmOdY2gQ1XZMk" #example covid chain as shown at https://invantium.com 
ids = "91bmwxTH8OtOG07HH9GF4AqbvqiYjmCsoGtXOjGoMh2oLZBRvyGy"



### Create post_data.  This is the entire message that gets sent to the TrxSys API
post_data = (f"{{"
			f"\"lg_name\":\"{lg_name}\","
			f"\"lg_password\":\"{lg_password}\","
			f"\"entry_type\":\"{entry_type}\","
			f"\"id_type\":\"{id_type}\","
			f"\"query_type\":\"{query_type}\","
			f"\"transaction_types\":\"{transaction_types}\","			
			f"\"display_rights_analysis\":\"{display_rights_analysis}\","
			f"\"timestart_epoch\":\"{timestart_epoch}\","
			f"\"timestop_epoch\":\"{timestop_epoch}\","
			f"\"echo_mode\":\"{echo_mode}\","
			f"\"debug_mode\":\"{debug_mode}\","
			f"\"ids\":\"{ids}\""
			f"}}")

#print (post_data) #optional

### Set headers to be included in message
headers = {'content-type': 'application/json'}

### Post message to TrxSys API
r = ""
try:
	r = requests.post(url = URL, data=post_data, headers=headers)
	print (r.text)
except:
	print ('ERROR')

The above example Python (v3) code demonstrates how to query a transaction from the TrxSys API based on transaction ID.

API Example: Query a transaction results

c:\python\scripts>query_consolidated_demo.py 200 OK {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"91bmwxTH8OtOG07HH9GF4AqbvqiYjmCsoGtXOjGoMh2oLZBRvyGy", "sender_timestamp_l_g":"1599145918","sender_message_decrypted":[2020-07-24, 4112531, 145546]}{"record_separator":"^^"}

The above example Python (v3) code demonstrates the results from a transaction query submitted to the TrxSys API.

Query a set of transactions for a Chain App ID using API

API Example: Query a Chain ID for list of transactions

### query_consolidated.py

### Robert Lawson Vaughn
### March 28, 2021
### Description:
### Program is used to query transactions by transaction ID, Chain App ID or collections of IDs from TrxSys via API
### Copyright 2021 TrxSys.com 

### Import modules
import requests
import base64
import json



### Set URL to point to API

URL = "https://trxsys.com/api/consolidated_query.pl"



### Set credentials values
lg_name = ""
lg_password = ""

### Optionally read credentials values from a file
# fileh = open ("credentials.txt")
# credentials = fileh.readlines
# lg_password = fileh.readline()
# lg_password = lg_password.strip('\n')


entry_type = "api"
	## Is required, no other to options.  Set to "api"
	
	
id_type = "2"
	## Is a required field
	## "1" query a single transaction ID or a collection of transaction IDs comma separated
	## "2" query a single chain ID or a collection of chain IDs comma separated
	## Do not mix transaction IDs and chain IDs.


query_type = "6"
	## Is a required field
	## "1" query transaction and return full transaction including decrypt message
	## "2" query transaction and return full transaction do not decrypt message
	## "3" query transaction but do not return message (because it could be really large)
	## "4" query transaction but only return transaction size (sender_message_size)
	## "5" binary responds with true if user has rights to the transaction, otherwise false if user does not have rights.
	## "6" query transaction(s) and return decrypted message, xnode_transaction)id, sender_chain_id, xnode_timestamp_l_g, sender_pid, recipient_pid
	

### Specify the type of transactions to include in the query
transaction_types = ""
	## Is an optional field, examples
	## "3" is a standard transaction
	## "4" is a transaction with data formatted to a chain app template
	## Multiple transaction types can be included comma separated 


 ### Specify time range to return results.  
timestart_epoch = "0" ## Is the older value
timestop_epoch = "0" ## Is the newer value
	## Are optional fields.  Use either, both or neither.
	## Is formatted as epoch.
	## Transactions outside of the specified range will not be included in the results set.
	## Set to "0" to not set a limit
	
display_rights_analysis = "no"
	## Is an optional field.  Defaults to "no"
	## "yes" displays transaction rights analysis
	## "no" 
	
	
echo_mode = "no"
	## Is an optional field.  Defaults to "yes"
	## "yes" echos back parameters sent to API
	## "no" does not echo back parameters sent to API
	
debug_mode = "no"
	## Is an optional field.  Defaults to "no"
	## "yes" echos back additional data on request processing
	## "no" does not display additional data
	


### If multiple IDs should be comma separated.  Do not mix chain ID with transaction IDs.  One or the other.
# fileids = open ("ids.txt")
# ids_file = fileids.readlines
# ids = fileids.readline()
# ids = ids.strip('\n')
#ids = "F0zrzuLyjASednvXwZU1o0N1RlwKeXeq1XpIihESmOdY2gQ1XZMk" #example covid chain as shown at https://invantium.com 
ids = "F0zrzuLyjASednvXwZU1o0N1RlwKeXeq1XpIihESmOdY2gQ1XZMk"



### Create post_data.  This is the entire message that gets sent to the TrxSys API
post_data = (f"{{"
			f"\"lg_name\":\"{lg_name}\","
			f"\"lg_password\":\"{lg_password}\","
			f"\"entry_type\":\"{entry_type}\","
			f"\"id_type\":\"{id_type}\","
			f"\"query_type\":\"{query_type}\","
			f"\"transaction_types\":\"{transaction_types}\","			
			f"\"display_rights_analysis\":\"{display_rights_analysis}\","
			f"\"timestart_epoch\":\"{timestart_epoch}\","
			f"\"timestop_epoch\":\"{timestop_epoch}\","
			f"\"echo_mode\":\"{echo_mode}\","
			f"\"debug_mode\":\"{debug_mode}\","
			f"\"ids\":\"{ids}\""
			f"}}")

#print (post_data) #optional

### Set headers to be included in message
headers = {'content-type': 'application/json'}

### Post message to TrxSys API
r = ""
try:
	r = requests.post(url = URL, data=post_data, headers=headers)
	print (r.text)
except:
	print ('ERROR')

The above example Python (v3) code demonstrates how to query a set of transactions (a Chain App ID) from the TrxSys API based on chain app ID.

API Example: Chain App ID query results

c:\python\scripts>query_consolidated_demo.py 200 OK {"transaction_ids_list":"EazoTCTZcUG6rZKpgtqNZiO5JUf9bc4wDKzk1JF0fbhBhTCax8r1,91bmwxTH8OtOG07HH9GF4AqbvqiYjmCsoGtXOjGoMh2oLZBRvyGy,QqTEGmeSTyPEIcoezGgf061zXtLZedxpur4cvILvKA5e4ua6zHf8,FG7IBTH7Q2o75anlIv96xh3ip5a2KkTHcJLU6GpdD6XDmifNRSiH,DJicyZ4Ern4O9PbOUHnmvAwsE3A52xQsoGltdDADaVHtNAxSGHTF,d0B7QM5MXNrIo4tdBdP4MGlypNMKuQoSzA0FV9uaRp8P1iFDeaS7,J3yyBP1PYjvYizeM8OmWTcJNHUXtgUU1cwCtdPYOveyWpiUMLjWc,27gVpLErn25uW6G6YYvBKvBE0l3WBP4YWluD35Wik8a21JhuLlJZ,zQGFJ3c2K3T7qDLaTbCmGRDe0DN0zizM35g01PnKmoQVzTfn0OOw"}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"EazoTCTZcUG6rZKpgtqNZiO5JUf9bc4wDKzk1JF0fbhBhTCax8r1","sender_timestamp_l_g":"1599151827","sender_message_decrypted":[2020-07-25, 4178021, 146460]}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"91bmwxTH8OtOG07HH9GF4AqbvqiYjmCsoGtXOjGoMh2oLZBRvyGy","sender_timestamp_l_g":"1599145918","sender_message_decrypted":[2020-07-24, 4112531, 145546]}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"QqTEGmeSTyPEIcoezGgf061zXtLZedxpur4cvILvKA5e4ua6zHf8","sender_timestamp_l_g":"1598905741","sender_message_decrypted":[2020-07-23, 4038748, 144304]}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"FG7IBTH7Q2o75anlIv96xh3ip5a2KkTHcJLU6GpdD6XDmifNRSiH","sender_timestamp_l_g":"1595525082","sender_message_decrypted":[2020-07-22, 3970906, 143190]}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"DJicyZ4Ern4O9PbOUHnmvAwsE3A52xQsoGltdDADaVHtNAxSGHTF","sender_timestamp_l_g":"1595449925","sender_message_decrypted":[2020-07-21, 3899211, 141995]}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"d0B7QM5MXNrIo4tdBdP4MGlypNMKuQoSzA0FV9uaRp8P1iFDeaS7","sender_timestamp_l_g":"1595449892","sender_message_decrypted":[2020-07-20, 3834677, 140913]}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"J3yyBP1PYjvYizeM8OmWTcJNHUXtgUU1cwCtdPYOveyWpiUMLjWc","sender_timestamp_l_g":"1595449845","sender_message_decrypted":[2020-07-19, 3773260, 140534]}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"27gVpLErn25uW6G6YYvBKvBE0l3WBP4YWluD35Wik8a21JhuLlJZ","sender_timestamp_l_g":"1595449704","sender_message_decrypted":[0]}{"record_separator":"^^"} {"sender_pid":"9h4Aeiy0PeaBYuKeD7bPOOtnOsfgf39c8kEti6jDETbsGZGAbd5J","xnode_transaction_id":"zQGFJ3c2K3T7qDLaTbCmGRDe0DN0zizM35g01PnKmoQVzTfn0OOw","sender_timestamp_l_g":"1595449674","sender_message_decrypted":[{{"sender_chain_common_name":"Covid_19_demo_1","sender_chain_id":"F0zrzuLyjASednvXwZU1o0N1RlwKeXeq1XpIihESmOdY2gQ1XZMk","authoritative_domain":"no","field_count":"1","chain_use_fee":"0","sender_add_to_public_index":"no","sender_chain_keywords":"Demo","chain_description":"RGVtbw=="}{{"field_name_1":"message","field_type_1":"text","field_description_1":"ZGVtbw==","field_name_def_value_1":"MA=="}}}]}{"record_separator":"^^"}

The above example Python (v3) code demonstrates the results from a Chain App ID query submitted to the TrxSys API.