Sirius Chain Developer Center 0.2.6

Sirius Chain Developer Center 0.2.6

  • Getting Started
  • Built-in Features
  • REST API Endpoints
  • Guides
  • Cheat Sheet

›REST API

Getting Started

  • What is ProximaX Sirius Chain
  • Setting up your workstation
  • Writing your first application

Built-in Features

  • Account
  • Mosaic
  • Namespace
  • Transfer Transaction
  • Aggregate Transaction
  • Multisig Account
  • Metadata
  • Account Restriction
  • Cross-Chain Swaps
  • Super Contracts

Protocol

  • Node
  • Block
  • Cryptography
  • Transaction
  • Validating
  • Consensus Algorithms
  • Receipt
  • Inflation

REST API

  • Overview
  • Tools
  • Serialization
  • Websockets
  • Status Errors

SDKs

  • Overview
  • Architecture
  • Languages
  • Extending Sirius Chain Capabilities
  • SDK Development
  • SDK Documentation

Client

  • Overview
  • Commands

Wallets & Explorers

  • Wallets & Explorers

Extensions

  • Overview
  • Sirius-Storage DFMS version extension

Cheat Sheet

  • Sirius Chain Cheat Sheet

REST API Overview

Sirius Chain REST API combines HTTP and Web Sockets to perform read and write actions in the Sirius Chain.

Requests

Sirius Chain REST uses port 3000. It accepts both HTTP GET, PUT and POST requests.

Assuming that Sirius Chain REST is running locally, HTTP GET requests can be executed from a browser and have the form:

http://localhost:3000/<path-to-API-request>

HTTP PUT and POST requests use JSON structures in the request body. Request returns data (if any is returned) using JSON structures. This request cannot usually be executed from within the browser unless you use a plugin which enables you to do it.

Sirius Chain REST API Endpoints

HTTP Errors

Status codeDescription
200Ok. The request has succeeded.
202Accepted. The request has been accepted for processing but the processing has not been completed.
400Bad request. Check your request syntax.
404Not found. The resource does not exist.
409Conflict. Check your arguments.
500Internal error. Unexpected condition.

Http status

KeyDescription
codeError identifier in camelCase.
messageError explained in human-readable format.

Example

{
  "code": "InvalidArgument",
  "message": "accountId has an invalid format"
}

uint64: lower and higher

Javascript operate on 32 bit values. To enable representation up to 64 bits, the API returns numbers encoded in two parts: lower and higher.

Check how to compact lower and higher into a single value.

← InflationTools →
  • Requests
  • HTTP Errors
  • Http status
  • Example
  • uint64: lower and higher
  • Join #general discussion
  • Ask development questions
  • Follow the dev updates
  • Explore Github
Protocol
BlockConsensus AlgorithmsCryptographyInflationNodeReceiptTransactionValidating
Built-in Features
AccountAccount FilterAggregate TransactionCross-Chain SwapsMetadataMosaicMultisig AccountNamespaceSuper contractTransfer Transaction
References
REST APISDKsXPX-Chain-CLICheat Sheet
Documentation Forked From NEM
Copyright © 2019 ProximaX