# Address The commands where under this section are used for address and balance actions. Read more about\ [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure) ## Create New Address > This endpoint is used to create a PIRI address. The successful result of a query includes the following information:\ > \ > \- \*\*pri\*\*: Private Key. This information is the most crucial for the privacy of the PIRI address. The basic security of the address depends on this information. Transactions related to the address, scenario creation, data sending and decryption, token creation, and more, require this information or the signature generated with it.\ > \ > \- \*\*pub\*\*: The PIRI address information in base58 format. It consists of 43 characters. It starts with PRTM and is followed by one of the letters P, Q, or R, totaling 43 characters. It is case-sensitive and is required for all address-based operations in the PIRI network. This information is public.\ > \ > \- \*\*words\*\*: A text sequence consisting of 24 words. Just like the Private Key information, it requires privacy. Additionally, this information can provide access to the Private Key information. It should be stored with high confidentiality.\ > \ > \- \*\*publicKey\*\*: This is a general and public information associated with the PIRI address. It is commonly used, especially in shared key generation stages.\ > \ > In addition, during the address creation process, if the "isCommercial" parameter is used and set to true:\ > \ > \- \*\*isCommercial\*\*: It returns true. This information represents whether a PIRI address is of commercial nature. Additionally, it is possible to convert a non-commercial PIRI address into a commercial address, but this can only be done once and in a one-way manner.\ > \ > To get more information about PIRI Wallet Structure, please visit \[Pirichain Wallet Structure]\() page on whitepaper. ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/createNewAddress":{"post":{"tags":["Address"],"summary":"Create New Address","description":"This endpoint is used to create a PIRI address. The successful result of a query includes the following information:\n\n- **pri**: Private Key. This information is the most crucial for the privacy of the PIRI address. The basic security of the address depends on this information. Transactions related to the address, scenario creation, data sending and decryption, token creation, and more, require this information or the signature generated with it.\n\n- **pub**: The PIRI address information in base58 format. It consists of 43 characters. It starts with PRTM and is followed by one of the letters P, Q, or R, totaling 43 characters. It is case-sensitive and is required for all address-based operations in the PIRI network. This information is public.\n\n- **words**: A text sequence consisting of 24 words. Just like the Private Key information, it requires privacy. Additionally, this information can provide access to the Private Key information. It should be stored with high confidentiality.\n\n- **publicKey**: This is a general and public information associated with the PIRI address. It is commonly used, especially in shared key generation stages.\n\nIn addition, during the address creation process, if the \"isCommercial\" parameter is used and set to true:\n\n- **isCommercial**: It returns true. This information represents whether a PIRI address is of commercial nature. Additionally, it is possible to convert a non-commercial PIRI address into a commercial address, but this can only be done once and in a one-way manner.\n\n To get more information about PIRI Wallet Structure, please visit [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure) page on whitepaper.","operationId":"createNewAddress","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"type":"object","properties":{"language":{"type":"string","description":"It can be used to specify in which language the secret words to be created will be.","enum":["english","french","korean","spanish","portuguese","italian","japanese","chinese_traditional"],"nullable":true,"default":"english"}}}}},"required":false},"responses":{"200":{"description":"OK | Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createNewAddress"}}}}},"deprecated":false}}},"components":{"schemas":{"createNewAddress":{"title":"createNewAddress","required":["pri","pub","words","publicKey"],"type":"object","properties":{"pri":{"type":"string"},"pub":{"type":"string"},"words":{"type":"string"},"publicKey":{"type":"string"},"isCommercial":{"type":"boolean","description":"Returns true if the created address is a commercial address. This field is only present for commercial addresses."}}}}}} ``` ## Convert To Commercial Address (TestNET) > This endpoint converts a PIRI address (individual wallet) that has not been previously converted to a commercial wallet into a commercial wallet. This operation is unidirectional, and it is not possible to convert a PIRI address that has been converted to a commercial wallet back into an individual wallet.\ > \ > Especially in the context of Dynamic Settlement, this conversion, which is useful for commercial purposes, also automatically carries the Public Key information associated with the address.\ > \ > \*\*One important point to be especially mindful of is that there is no possibility of transferring or sending data between these two different wallet types. In other words, it is not possible to transfer to or send data to an individual address from a commercial address, and vice versa. Individual and commercial addresses can only perform transfers and data exchange within their own types.\*\* ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"description":"Pirichain TestNet Environment","url":"https://testnet.pirichain.com"}],"paths":{"/convertToCommercialWallet":{"post":{"tags":["Address"],"summary":"Convert To Commercial Address (TestNET)","description":"This endpoint converts a PIRI address (individual wallet) that has not been previously converted to a commercial wallet into a commercial wallet. This operation is unidirectional, and it is not possible to convert a PIRI address that has been converted to a commercial wallet back into an individual wallet.\n\nEspecially in the context of Dynamic Settlement, this conversion, which is useful for commercial purposes, also automatically carries the Public Key information associated with the address.\n\n**One important point to be especially mindful of is that there is no possibility of transferring or sending data between these two different wallet types. In other words, it is not possible to transfer to or send data to an individual address from a commercial address, and vice versa. Individual and commercial addresses can only perform transfers and data exchange within their own types.**","operationId":"convertToCommercialWallet","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["address","privateKey","alias"],"type":"object","properties":{"address":{"type":"string","description":"PIRI Address"},"privateKey":{"type":"string","description":"Private Key"},"alias":{"type":"string","maxLength":64,"description":"Commercial Alias of Address"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/sendToken"}}}}},"deprecated":false}}},"components":{"schemas":{"sendToken":{"required":["error","tx","sign","timeStamp"],"type":"object","properties":{"error":{"type":"integer","format":"int32","description":"Error status code. 0 indicates success, non-zero indicates an error."},"tx":{"type":"string","description":"The transaction hash identifier for the completed token transfer transaction."},"sign":{"type":"string","description":"The cryptographic signature of the transaction, ensuring its authenticity and integrity."},"timeStamp":{"type":"integer","format":"int64","description":"The Unix timestamp (in milliseconds) when the transaction was processed."}}}}}} ``` ## Rescue Private Key from Mnemonic Words > This endpoint is used to retrieve the Private Key information associated with a PIRI address. The PIRI address system uses a set of 24 words from the bip39 library. The words are case-sensitive and should be sent with spaces between them.\ > \ > If the sent words are complete and arranged to represent a PIRI address as per the following schema, information will be returned. ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/rescuePrivateKey":{"post":{"tags":["Address"],"summary":"Rescue Private Key from Mnemonic Words","description":"This endpoint is used to retrieve the Private Key information associated with a PIRI address. The PIRI address system uses a set of 24 words from the bip39 library. The words are case-sensitive and should be sent with spaces between them.\n\nIf the sent words are complete and arranged to represent a PIRI address as per the following schema, information will be returned.","operationId":"rescuePrivateKey","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["words"],"type":"object","properties":{"words":{"type":"string","description":"A string of 24 words with a space between them"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/rescuePrivateKey"}}}}},"deprecated":false}}},"components":{"schemas":{"rescuePrivateKey":{"title":"rescuePrivateKey","required":["pri","base58"],"type":"object","properties":{"pri":{"type":"string"},"base58":{"$ref":"#/components/schemas/Base58"}}},"Base58":{"title":"Base58","required":["pub","base58"],"type":"object","properties":{"pub":{"type":"string"},"base58":{"type":"string"}}}}}} ``` ## Get Mnemonic Words from Private Key > This endpoint is used to retrieve 24 words that compose a PIRI address. It takes the Private Key information related to the PIRI address as a parameter and returns a result based on the following schema.\ > \ > Additionally, this endpoint also accepts the "language" parameter as optional. While its default value is set to "english," one of the language choices listed in the table can also be sent as the parameter value.\ > \ > For more detailed information about transaction tables related to the bip39 library, you can visit \[Bip39 Explanation]\() page ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getMnemonic":{"post":{"tags":["Address"],"summary":"Get Mnemonic Words from Private Key","description":"This endpoint is used to retrieve 24 words that compose a PIRI address. It takes the Private Key information related to the PIRI address as a parameter and returns a result based on the following schema.\n\nAdditionally, this endpoint also accepts the \"language\" parameter as optional. While its default value is set to \"english,\" one of the language choices listed in the table can also be sent as the parameter value.\n\nFor more detailed information about transaction tables related to the bip39 library, you can visit [Bip39 Explanation](https://learnmeabitcoin.com/technical/mnemonic) page","operationId":"getMnemonic","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["privateKey"],"type":"object","properties":{"privateKey":{"type":"string","description":"Private Key of PIRI Address"},"language":{"type":"string","description":"It can be used to indicate in which language the words to be retrieved will be.","enum":["english","french","korean","spanish","portuguese","italian","japanese","chinese_traditional"],"nullable":true,"default":"english"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/getMnemonic"}}}}},"deprecated":false}}},"components":{"schemas":{"getMnemonic":{"title":"getMnemonic","required":["error","mnemonic"],"type":"object","properties":{"error":{"type":"integer","format":"int32"},"mnemonic":{"type":"string"}}}}}} ``` ## Get Balance for an Address > This endpoint returns the quantity of a specific asset associated with a PIRI address. The type of this asset is provided through the assetID parameter. In different systems, this information is also referred to as the contract address for the asset type. In the PIRI network, there is no contract address for an asset; instead, the assetID value is used.\ > \ > For the PIRI asset, this value is -1. For other assets (Tokens), the relevant values can be seen through the listTokens endpoint.\ > \ > A successful query will result in the following schema, as shown below. ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getBalance":{"post":{"tags":["Address"],"summary":"Get Balance for an Address","description":"This endpoint returns the quantity of a specific asset associated with a PIRI address. The type of this asset is provided through the assetID parameter. In different systems, this information is also referred to as the contract address for the asset type. In the PIRI network, there is no contract address for an asset; instead, the assetID value is used.\n\nFor the PIRI asset, this value is -1. For other assets (Tokens), the relevant values can be seen through the listTokens endpoint.\n\nA successful query will result in the following schema, as shown below.","operationId":"getBalance","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["address","assetID"],"type":"object","properties":{"address":{"type":"string","description":"PIRI Address"},"assetID":{"type":"number","description":"ID of asset | -1 should be sent for PIRI asset"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/getBalance"}}}}},"deprecated":false}}},"components":{"schemas":{"getBalance":{"title":"getBalance","required":["error","name","symbol","logo","assetID","address","frozen","balance"],"type":"object","properties":{"error":{"type":"integer","format":"int32"},"name":{"type":"string"},"symbol":{"type":"string"},"logo":{"type":"string","description":"Asset logo URL or base64 encoded image data"},"assetID":{"type":"integer","format":"int32"},"address":{"type":"string"},"frozen":{"type":"array","items":{"type":"string"},"description":"List of frozen amounts or details"},"balance":{"type":"string","format":"decimal"}}}}}} ``` ## Get Asset List for an Address > This endpoint will provide a list of all assets belonging to a PIRI address.\ > \ > A successful query result will look like the schema below. ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getBalanceList":{"post":{"tags":["Address"],"summary":"Get Asset List for an Address","description":"This endpoint will provide a list of all assets belonging to a PIRI address.\n\nA successful query result will look like the schema below.","operationId":"getBalanceList","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"PIRI Address"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/getBalance"}}}}}},"deprecated":false}}},"components":{"schemas":{"getBalance":{"title":"getBalance","required":["error","name","symbol","logo","assetID","address","frozen","balance"],"type":"object","properties":{"error":{"type":"integer","format":"int32"},"name":{"type":"string"},"symbol":{"type":"string"},"logo":{"type":"string","description":"Asset logo URL or base64 encoded image data"},"assetID":{"type":"integer","format":"int32"},"address":{"type":"string"},"frozen":{"type":"array","items":{"type":"string"},"description":"List of frozen amounts or details"},"balance":{"type":"string","format":"decimal"}}}}}} ``` ## Get public key for an address > Get the public key associated with a specific address. ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getPubKey":{"post":{"tags":["Address"],"summary":"Get public key for an address","description":"Get the public key associated with a specific address.","operationId":"getPubKey","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["address"],"properties":{"address":{"type":"string","description":"The address to get the public key for"}}}}}},"responses":{"200":{"description":"Response with public key information or an error message.","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/getPubKey"}}}}}}}},"components":{"schemas":{"getPubKey":{"title":"getPubKeyResponse","type":"object","required":["error","data"],"properties":{"error":{"type":"integer","description":"Error code: 0 for success, 1 for not found.","enum":[0,1]},"data":{"type":"string","description":"Public key as a hex string when found, or an error message when not found."}}}}}} ``` ## Validate PIRI Address > This endpoint validates whether a given address is a valid PIRI address format. ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/isValidAddress":{"post":{"tags":["Address"],"summary":"Validate PIRI Address","description":"This endpoint validates whether a given address is a valid PIRI address format.","operationId":"isValidAddress","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"PIRI Address to validate"}}}}},"required":true},"responses":{"200":{"description":"Address validation result","content":{"application/json":{"schema":{"type":"boolean","description":"True if address is valid, false if invalid"}}}}},"deprecated":false}}}} ``` ## Get detailed address information > Get detailed information about a specific address, such as transaction counts and deputy status. ```json {"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Address","description":"The commands where under this section are used for address and balance actions.\n\n Read more about \\\n [Pirichain Wallet Structure](https://whitepaper.pirichain.com/v1.0.3/pirichain-infrastructure/pirichain-infrastructure/1.3.-pirichain-wallet-structure)"}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getDetailsOfAddress":{"post":{"tags":["Address"],"summary":"Get detailed address information","description":"Get detailed information about a specific address, such as transaction counts and deputy status.","operationId":"getDetailsOfAddress","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["address"],"properties":{"address":{"type":"string","description":"The address to get details for"}}}}}},"responses":{"200":{"description":"Address details retrieved successfully","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/getDetailsOfAddress"}}}}}}}},"components":{"schemas":{"getDetailsOfAddress":{"title":"getDetailsOfAddress","type":"object","properties":{"error":{"type":"integer","format":"int32","description":"Error code, 0 for success"},"inOutAddr":{"type":"object","description":"Transaction counts for the address","properties":{"in":{"type":"number","description":"Total number of incoming transactions"},"out":{"type":"number","description":"Total number of outgoing transactions"}}},"isDep":{"type":"boolean","description":"Indicates if the address belongs to a deputy"},"depWebsite":{"type":"string","description":"The website of the deputy, if applicable"},"verified":{"type":"boolean","description":"Indicates if the address is verified"}}}}}} ```