View Source Radixir.Core.API (radixir v0.0.3)
Submits requests to Core API.
Link to this section Summary
Functions
Submits request to /construction/build
.
Submits request to /construction/derive
.
Submits request to /construction/finalize
.
Submits request to /transactions
.
Submits request to /entity
.
Submits request to /mempool/transaction
.
Submits request to /mempool
.
Submits request to /network/configuration
.
Submits request to /network/status
.
Submits request to /key/list
.
Submits request to /construction/hash
.
Submits request to /construction/parse
.
Submits request to /key/sign
.
Submits request to /construction/submit
.
Link to this section Types
Link to this section Functions
Specs
Submits request to /construction/build
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /construction/derive
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /construction/finalize
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /transactions
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /entity
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /mempool/transaction
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /mempool
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /network/configuration
.
Parameters
options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /network/status
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /key/list
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /construction/hash
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /construction/parse
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /key/sign
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.
Core API Documentation
Specs
Submits request to /construction/submit
.
Parameters
body
: Request body.options
: Keyword list that containsurl
(optional, string): Ifurl
is not found inoptions
then the url set in the configs will be used.auth_index
(optional, string):auth_index
is the index of the username + password combo to be used for endpoint authentication.username
: (optional, string):username
to be used for endpoint authentication.password
: (optional, string):password
to be used for endpoint authentication.
Note
- Either
username
andpassword
orauth_index
must be provided. - If all three are provided
auth_index
is used.
Example
If the following usernames and passwords are exported:
export USERNAMES='admin, superadmin, metrics'
export PASSWORDS='funny cats very Jack 21!, harry Kack love h39! LW, monitor Kat darrel 23 Jack!'
then passing auth_index: 0
would lead to admin
being used as the username
and funny cats very Jack 21!
being used as the password
for endpoint authentication.