-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
198 lines (152 loc) · 5.54 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
FORMAT: 1A
# Horizon
The horizon description goes here
## Account [/accounts/{address}]
Represents the current state of an account as of the latest closed
ledger imported by horizon.
+ Model (application/hal+json)
{
"_links": {
"self": {
"href": "/accounts/gjgPNE2GpySt5iYZaFFo1svCJ4gbHwXxUy8DDqeYTDK6UzsPTs"
},
"transactions": {
"href": "/accounts/gjgPNE2GpySt5iYZaFFo1svCJ4gbHwXxUy8DDqeYTDK6UzsPTs/transactions{?order}{?limit}{?after}{?before}"
}
},
"id": "gjgPNE2GpySt5iYZaFFo1svCJ4gbHwXxUy8DDqeYTDK6UzsPTs",
"address": "gjgPNE2GpySt5iYZaFFo1svCJ4gbHwXxUy8DDqeYTDK6UzsPTs",
"sequence": 3,
"balances": [{
"currency": {
"type": "native"
},
"balance": 100000000
},{
"currency": {
"type": "iso4217",
"code": "USD",
"issuers": "gM4gu1GLe3vm8LKFfRJcmTt1eaEuQEbo61a8BVkGcou78m21K7"
},
"balance": 100000000
}],
}
### View account details [GET]
+ Parameters
+ address (required, string, `gjgPNE2GpySt5iYZaFFo1svCJ4gbHwXxUy8DDqeYTDK6UzsPTs`) ... Address of an account
+ Response 200
[Account][]
## Transaction [/transactions/{hash}]
Represents a single transaction that has been submitted and validated by the payshares network
+ Model (application/hal+json)
{
"_links": {
"self": {
"href": "/transactions/4774bce2ddf7cf9332d5f97ab7f7bff115291d5598c7eec827f43ca58bd4fa06"
},
"account": {
"href": "/accounts/gM4gu1GLe3vm8LKFfRJcmTt1eaEuQEbo61a8BVkGcou78m21K7"
}
},
"hash": "4774bce2ddf7cf9332d5f97ab7f7bff115291d5598c7eec827f43ca58bd4fa06",
"ledger": 7,
"application_order": [
7,
2
],
"account": "gM4gu1GLe3vm8LKFfRJcmTt1eaEuQEbo61a8BVkGcou78m21K7",
"account_sequence": 2,
"max_fee": 10,
"fee_paid": 10,
"operation_count": 1,
}
### View transaction's details [GET]
+ Parameters
+ hash (required, string, `0ab231385734ad4092cc0651f3acd2a6e3eead24282f2725a79d019d4b791d54`) ... The hex-encoded hash of a transaction
+ Response 200
[Transaction][]
## Transaction Collection [/transactions{?order}{?limit}{?after}]
+ Model (application/hal+json)
{
"_links": {
"next": {
"href": "/transactions?after=373a31&limit=1&order=asc"
}
},
"_embedded": {
"records": [
{
"_links": {
"self": {
"href": "/transactions/0ab231385734ad4092cc0651f3acd2a6e3eead24282f2725a79d019d4b791d54"
},
"account": {
"href": "/accounts/gM4gu1GLe3vm8LKFfRJcmTt1eaEuQEbo61a8BVkGcou78m21K7"
}
},
"hash": "0ab231385734ad4092cc0651f3acd2a6e3eead24282f2725a79d019d4b791d54",
"ledger": 7,
"application_order": [
7,
1
],
"account": "gM4gu1GLe3vm8LKFfRJcmTt1eaEuQEbo61a8BVkGcou78m21K7",
"account_sequence": 1,
"max_fee": 10,
"fee_paid": 10,
"operation_count": 1
}
]
}
}
### View a page of transaction history [GET]
+ Parameters
+ after (optional, string, `373a31`) ... A paging token
+ limit (optional, number, `10`) ... The maximum number of transactions to return in the response
+ order (string)
The order to traverse the transaction collection
+ Values
+ `asc`
+ `desc`
+ Response 200
[Transaction Collection][]
### Submitting a transaction [POST]
+ Parameters
+ tx (required, string, `ffffff`) ... The hex-encoded xdr form of the transaction to be submitted
+ Request (application/x-www-form-urlencoded)
tx=fffff
+ Response 200 (application/hal+json)
{
"hash": "67071d24b1859ea5f2f5315961ab84accebea8f6ec907aed728d172ba7058acf",
"result": "already_finished",
"submission_result": null,
"_links": {
"transaction": {
"href": "/transactions/67071d24b1859ea5f2f5315961ab84accebea8f6ec907aed728d172ba7058acf"
}
}
}
+ Response 201 (application/hal+json)
{
"hash": "64672a11e41f1e0530e49dcf6aedd3cf00ba4314ed240f18dfaad6730d1a9afc",
"result": "received",
"submission_result": "000000000000000a0000000000000001000000000000000000000000"
}
## Friendbot (Currency Faucet) [/friendbot]
When configured with a secret key, horizon can fund accounts to help you test your applications. Friendbot gives them out.
### Fund Account [POST]
+ Request (application/x-www-form-urlencoded)
addr=gsaKhsFcxHmo3PMeCHrvHJAcqJrLhy11WexgUiwRMmz7cpKV55w
+ Response 200 (application/hal+json)
{
"hash": "64672a11e41f1e0530e49dcf6aedd3cf00ba4314ed240f18dfaad6730d1a9afc",
"result": "received",
"submission_result": "000000000000000a0000000000000001000000000000000000000000"
}
+ Response 404 (application/hal+json)
{
"type": "not_found",
"status": 404,
"title": "Resource Missing",
"instance": "request://08a9edea-a20c-4b93-95b5-fdfff985b4c9"
}