Namespace
Note zachys (atomic units) are 10^6 in X-Cash

Stats

This method gets the stats
Method: GET
Inputs: None.
Results:
  • totalNamesRegisteredOrRenewed - unsigned int; The total registered or renewed names the delegates have processed.
  • totalVolume - unsigned long long; The total xcash paid to delegates using the namespace protocol in zachys (atomic units).
1
$ curl -X GET https://api.xcash.foundation/v1/xcash/namespace/unauthorized/stats/ -H 'Accept: application/json'
2
{
3
"totalNamesRegisteredOrRenewed": 100,
4
"totalVolume": 10000000
5
}
Copied!

Registered Delegates

This method gets all of the registered delegates
Method: GET
Inputs: None.
Results:
Array of objects with the following structure:
  • delegateName - string; The delegate name.
  • amount - unsigned long long; The amount to register or renew a name, using this delegate in zachys (atomic units).
1
$ curl -X GET https://api.xcash.foundation/v1/xcash/namespace/unauthorized/delegates/registered/ -H 'Accept: application/json'
2
[
3
{
4
"delegateName": "us1_xcash_foundation",
5
"amount": 100000000
6
},
7
{
8
"delegateName": "europe1_xcash_foundation",
9
"amount": 100000000
10
}
11
]
Copied!

Delegates

This method gets the delegates data
Method: GET
Resources:
  • delegateName - Required - The delegates name.
Results:
  • delegateName - string; The delegate name.
  • publicAddress - string; The public address.
  • amount - unsigned long long; The amount that a delegate charges to register or renew a name in zachys (atomic units).
  • totalNamesRegisteredOrRenewed - unsigned int; The total registered or renewed names that the delegate has processed.
  • totalVolume - unsigned long long; The total xcash paid to delegates using the namespace protocol in zachys (atomic units).
1
$ curl -X GET https://api.xcash.foundation/v1/xcash/namespace/unauthorized/delegates/us1_xcash_foundation/ -H 'Accept: application/json'
2
{
3
"delegateName": "us1_xcash_foundation",
4
"publicAddress": "XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf",
5
"amount": 100000000,
6
"totalNamesRegisteredOrRenewed": 100,
7
"totalVolume": 10000000
8
}
Copied!

Names

This method gets the names data for a specific name
Method: GET
Resources:
  • name - Required - The namespace.
Results:
  • address - string; The address.
  • saddress - string; The saddress.
  • paddress - string; The paddress.
  • expires - unsigned int; The time the domain expires.
  • delegateName - string; The delegate that registered the namespace.
  • delegateAmount - unsigned long long; The total xcash paid to delegates to register or renew the namespace in zachys (atomic units).
1
$ curl -X GET https://api.xcash.foundation/v1/xcash/namespace/unauthorized/names/xcash/ -H 'Accept: application/json'
2
{
3
"address": "XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf",
4
"saddress": "XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf",
5
"paddress": "XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf",
6
"expires": 1654228489,
7
"delegateName": "us1_xcash_foundation",
8
"delegateAmount": 100000000
9
}
Copied!

Name Status

This method checks if a name can be purchased,either by it has not been registered yet, or it has expired
Method: GET
Resources:
  • name - Required - The namespace.
Results:
  • status - bool; True if one can register the name, otherwise false.
1
$ curl -X GET https://api.xcash.foundation/v1/xcash/namespace/unauthorized/names/status/xcash/ -H 'Accept: application/json'
2
{
3
"status": false
4
}
Copied!

Address Status

This method gets the address status
Method: GET
Resources:
  • address - Required - The address.
Results:
  • status - string; "not registered|address|saddress|paddress"
1
$ curl -X GET https://api.xcash.foundation/v1/xcash/namespace/unauthorized/addresses/status/XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf/ -H 'Accept: application/json'
2
{
3
"status": "address"
4
}
Copied!

Name To Address

This method converts a name to an address
Method: GET
Resources:
  • name - Required - The namespace
Results:
  • address - string; The address.
  • saddress - string; The saddress.
  • paddress - string; The paddress.
1
$ curl -X GET https://api.xcash.foundation/v1/xcash/namespace/unauthorized/names/convert/xcash/ -H 'Accept: application/json'
2
{
3
"address": "XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf",
4
"saddress": "XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf",
5
"paddress": "XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf"
6
}
Copied!

Address To Name

This method converts an address to a name and extension
Method: GET
Resources:
  • address - Required - The address.
Results:
  • name - string; The name.
  • extension - string; The extension.
1
$ curl -X GET https://api.xcash.foundation/v1/xcash/namespace/unauthorized/addresses/convert/XCA1a9usG2UKajV1Dqzp8fL1BbN3hzuaaJMYjCo7qDoC4C3Vvc5owiLAqKbVw2cRbwRqx3mgrau1Z7LkX6cxR2NC4ZmFBLe2Mf/ -H 'Accept: application/json'
2
{
3
"name": "xcash",
4
"extension": ".pxcash"
5
}
Copied!