Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
B
Breeze
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
3
Issues
3
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DeStream-public
Breeze
Commits
5c919e29
Commit
5c919e29
authored
Mar 28, 2017
by
nopara73
Committed by
Jeremy Bokobza
Mar 28, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add documentation (
#3
)
* Add documentation * Update ApiSpecification.md * Update ApiSpecification.md
parent
230b9cdc
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
54 additions
and
0 deletions
+54
-0
ApiSpecification.md
Breeze.Documentation/ApiSpecification.md
+54
-0
No files found.
Breeze.Documentation/ApiSpecification.md
0 → 100644
View file @
5c919e29
`/api/v1/`
## Request/Response
RESPONSE: responsecode (
`200`
if success,
`400`
/
`500`
if error, see later)
HEADERS
`Content-Type:application/json`
## Errors
`400`
series status codes for client issues &
`500`
series status codes for server issues.
API should standardize that all
`400`
series errors come with consumable JSON error representation.
BODY
```
{
"message" : "Something bad happened :(", // ex.Message maybe?
"description" : ex.ToString()
}
```
## Key Management
```
GET /wallet/general - Displays general information on the wallet
GET /wallet/sensitive - Displays sensitive information on the wallet
GET /wallet/status - Displays dynamic information on the wallet
POST /wallet/create - Creates the wallet
POST /wallet/load - Loads the wallet and starts syncing
POST /wallet/recover - Recovers the wallet
DELETE /wallet - Deletes the wallet
```
## Syncing
```
GET /wallet/mempool/?allow=[true/false] - Allows or disallows mempool syncing
```
## Key Monitoring
```
GET /wallet/receive/[account1/account2] - Displays unused receive addresses of the specified wallet account
GET /wallet/history/[account1/account2] - Displays the history of the specified wallet account
GET /wallet/balance/[account1/account2] - Displays the balances of the specified wallet account
```
## Transaction building and sending
```
POST /wallet/build-transaction/[account1/account2] - Attempts to build a transaction with the specified wallet account
POST /wallet/send-transaction - Attempts to send a transaction
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment