{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"32875464-bd14-42c5-9893-7d294f4598ff","name":"Core API","description":"| Core API Revision (OpenAPI Doc Version) | v1.0.0 |\n| --- | --- |\n| Radix Release | v1.1.0 |\n\nThis API provides endpoints from a node for integration with the Radix ledger.\n\n# Overview\n\n> WARNING\n> \n> The Core API is **NOT** intended to be available on the public web. It is  \n> designed to be accessed in a private network.\n\nThe Core API is separated into three:\n\n*   The **Data API** is a read-only api which allows you to view and  \n    sync to the state of the ledger.\n*   The **Construction API** allows you to construct and submit a transaction  \n    to the network.\n*   The **Key API** allows you to use the keys managed by the node to sign transactions.\n    \n\nThe Core API is a low level API primarily designed for network integrations  \nsuch as exchanges, ledger analytics providers, or hosted ledger data dashboards  \nwhere detailed ledger data is required and the integrator can be expected to  \nrun their node to provide the Core API for their own consumption.\n\nFor a higher level API, see the [Gateway API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/radixdlt/radixdlt-network-gateway/develop/generation/gateway-api-spec.yaml).\n\nFor node monitoring, see the [System API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/radixdlt/radixdlt/develop/radixdlt-core/radixdlt/src/main/java/com/radixdlt/api/system/api.yaml).\n\n## Rosetta\n\nThe Data API and Construction API is inspired from [Rosetta API](https://www.rosetta-api.org/)  \nmost notably:\n\n*   Use of a JSON-Based RPC protocol on top of HTTP Post requests\n*   Use of Operations, Amounts, and Identifiers as universal language to  \n    express asset movement for reading and writing\n    \n\nThere are a few notable exceptions to note:\n\n*   Fetching of ledger data is through a Transaction stream rather than a  \n    Block stream\n*   Use of `EntityIdentifier` rather than `AccountIdentifier`\n*   Use of `OperationGroup` rather than `related_operations` to express related  \n    operations\n*   Construction endpoints perform coin selection on behalf of the caller.  \n    This has the unfortunate effect of not being able to support high frequency  \n    transactions from a single account. This will be addressed in future updates.\n*   Construction endpoints are online rather than offline as required by Rosetta\n    \n\nFuture versions of the api will aim towards a fully-compliant Rosetta API.\n\n## Enabling Endpoints\n\nAll endpoints are enabled when running a node with the exception of two endpoints, each of  \nwhich need to be manually configured to access:\n\n*   `/transactions` endpoint must be enabled with configuration `api.transaction.enable=true`.  \n    This is because the transactions endpoint requires additional database storage which may not  \n    be needed for users who aren't using this endpoint\n*   `/key/sign` endpoint must be enable with configuration `api.sign.enable=true`. This is a  \n    potentially dangerous endpoint if accessible publicly so it must be enabled manually.\n    \n\n## Client Code Generation\n\nWe have found success with generating clients against the  \n[api.yaml specification](https://raw.githubusercontent.com/radixdlt/radixdlt/develop/radixdlt-core/radixdlt/src/main/java/com/radixdlt/api/core/api.yaml).  \nSee [https://openapi-generator.tech/](https://openapi-generator.tech/) for more details.\n\nThe OpenAPI generator only supports openapi version 3.0.0 at present, but you can  \nchange 3.0.0 to 3.0.0 in the first line of the spec without affecting generation.\n\n# Data API Flow\n\nThe Data API can be used to synchronize a full or partial view of the ledger,  \ntransaction by transaction.\n\n![](https://raw.githubusercontent.com/radixdlt/radixdlt/feature/update-documentation/radixdlt-core/radixdlt/src/main/java/com/radixdlt/api/core/documentation/data_sequence_flow.png)\n\n# Construction API Flow\n\nThe Construction API can be used to construct and submit transactions to the network.\n\n![](https://raw.githubusercontent.com/radixdlt/radixdlt/feature/open-api/radixdlt-core/radixdlt/src/main/java/com/radixdlt/api/core/documentation/construction_sequence_flow.png)\n\nUnlike the Rosetta Construction API [specification](https://www.rosetta-api.org/docs/construction_api_introduction.html),  \nthis Construction API selects UTXOs on behalf of the caller. This has the unfortunate  \nside effect of not being able to support high frequency transactions from a single  \naccount due to UTXO conflicts. This will be addressed in a future release.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14449947","team":17553773,"collectionId":"32875464-bd14-42c5-9893-7d294f4598ff","publishedId":"UVXnHaJh","public":true,"publicUrl":"https://documenter-api.postman.tech/view/14449947/UVXnHaJh","privateUrl":"https://go.postman.co/documentation/14449947-32875464-bd14-42c5-9893-7d294f4598ff","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2022-01-19T14:34:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Mainnet","id":"a2250ab1-feb3-4115-bffa-05232cb85a7d","owner":"14449947","values":[{"key":"gatewayBaseUrl","value":"https://mainnet.radixdlt.com","enabled":true},{"key":"coreBaseUrl","value":"https://my-validator.com","enabled":true,"type":"default"},{"key":"systemBaseUrl","value":"https://my-validator.com","enabled":true,"type":"default"},{"key":"network","value":"mainnet","enabled":true,"type":"default"},{"key":"sender_address_1","value":"rdx1qsp8n0nx0muaewav2ksx99wwsu9swq5mlndjmn3gm9vl9q2mzmup0xqm2ylge","enabled":true,"type":"default"},{"key":"receiver_address_1","value":"rdx1qspvvprlj3q76ltdxpz5qm54cp7dshrh3e9cemeu5746czdet3cfaegp8alwf","enabled":true,"type":"default"},{"key":"validator_address_1","value":"","enabled":true,"type":"default"},{"key":"public_key_hex","value":"0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798","enabled":true,"type":"default"},{"key":"native_token_rri","value":"xrd_rr1qy5wfsfh","enabled":true,"type":"default"},{"key":"token_rri","value":"","enabled":true,"type":"default"},{"key":"unsigned_transaction","value":"0d00010753db21ab607121e70455bf99373e2bf11f4a0c4214a7d19fb504973e75370daa00000001010021000000000000000000000000000000000000000000000000000101ed50bab180000200450600040279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f817980100000000000000000000000000000000000000000000000179f9b5b28e89ff94000800000200450600040279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f817980100000000000000000000000000000000000000000000000179f9b5b28e89ff3002004506000402c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee501000000000000000000000000000000000000000000000000000000000000006400","enabled":true,"type":"default"},{"key":"signature_bytes","value":"3046022100cda0fcd31bf976aa65c31c180b4f595a61c866252c52898b952b8fe1d8fdcc33022100999e83036f9529c6250c07423d8b57f252dfba1b843385970bfa69f2c367658e","enabled":true,"type":"default"},{"key":"signed_transaction","value":"0d00010776bf65acf2d25e9dcf4c716f5f39f201dccbfa173ad9c7f1c1dbcb8a86776b4d0000000101002100000000000000000000000000000000000000000000000000012901c1cf3900000200450600040279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798010000000000000000000000000000000000000000000000017afba303493b7ff8000800000200450600040279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798010000000000000000000000000000000000000000000000017afba303493b7f9402004506000402c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5010000000000000000000000000000000000000000000000000000000000000064000c0034303030303663366636313634323037343635373337343639366536373230373437323631366537333631363337343639366636650b00cda0fcd31bf976aa65c31c180b4f595a61c866252c52898b952b8fe1d8fdcc33999e83036f9529c6250c07423d8b57f252dfba1b843385970bfa69f2c367658e","enabled":true,"type":"default"},{"key":"tx_id","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/66eaa47c2181a884b61524479c9cb52dcb08052e0e177e78af232627d9ac2f7c","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Mainnet","value":"14449947-a2250ab1-feb3-4115-bffa-05232cb85a7d"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UVXnHaJh"}