http API

post

Body

application/json

tostring · min: 66 · max: 66Required

amountnumber · min: 1e-8Required

Responses

200

Successful operation

No content

post

/transaction/generate

HTTPcURLJavaScriptPython

POST /transaction/generate HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "to": "text",
  "amount": 1
}

200

Successful operation

No content

post

Body

application/json

fromstring · min: 66 · max: 66Required

tostring · min: 66 · max: 66Required

amountnumber · min: 1e-8Required

feenumber · min: 1e-11Required

timestampintegerRequired

hashstring · min: 64 · max: 64Required

signaturestring · min: 128 · max: 128Required

Responses

200

Successful operation

No content

post

/transaction/init

HTTPcURLJavaScriptPython

POST /transaction/init HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "from": "text",
  "to": "text",
  "amount": 1,
  "fee": 1,
  "timestamp": 1,
  "hash": "text",
  "signature": "text"
}

200

Successful operation

No content

get

Path parameters

addressstring · min: 66 · max: 66Required

Query parameters

limitinteger · max: 30Optional

maxIdintegerOptional

orderstring · enumOptionalPossible values:

Responses

200

Successful operation

No content

get

/transaction/by-address/{address}

HTTPcURLJavaScriptPython

GET /transaction/by-address/{address} HTTP/1.1
Host: localhost:3000
Accept: */*

200

Successful operation

No content

get

Path parameters

addressstring · min: 66 · max: 66Required

Responses

200

Successful operation

No content

get

/transaction/count-by-address/{address}

HTTPcURLJavaScriptPython

GET /transaction/count-by-address/{address} HTTP/1.1
Host: localhost:3000
Accept: */*

200

Successful operation

No content

post

Body

application/json

addressstring · uriRequiredPattern: ^(http|https)://.*$

Responses

200

Successful operation

No content

post

/peer

HTTPcURLJavaScriptPython

POST /peer HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "address": "https://example.com"
}

200

Successful operation

No content

get

Path parameters

idintegerRequired

Responses

200

OK

No content

get

/block/{id}

HTTPcURLJavaScriptPython

GET /block/{id} HTTP/1.1
Host: localhost:3000
Accept: */*

200

OK

No content

get

Path parameters

addressstring · min: 66 · max: 66Required

Responses

200

OK

application/json

get

/balance/{address}

HTTPcURLJavaScriptPython

GET /balance/{address} HTTP/1.1
Host: localhost:3000
Accept: */*

200

OK

{
  "address": "text",
  "balance": 1,
  "burned": 1,
  "affectedBlockId": 1,
  "createdAt": "text",
  "updatedAt": "text"
}

get

Query parameters

fromIdintegerOptional

limitinteger · max: 30Optional

Responses

200

OK

No content

get

/block/chain

HTTPcURLJavaScriptPython

GET /block/chain HTTP/1.1
Host: localhost:3000
Accept: */*

200

OK

No content

get

Path parameters

blockIdintegerRequired

Header parameters

authorizationstringRequired

Responses

200

OK

No content

get

/secure/remove-chain-to/{blockId}

HTTPcURLJavaScriptPython

GET /secure/remove-chain-to/{blockId} HTTP/1.1
Host: localhost:3000
authorization: text
Accept: */*

200

OK

No content