/startCollector
1 min
POST
http://1.1.1.1/startCollector
Query Parameters
- configobjectrequiredDescriptionDefault{ "account_id_to_collector_address": { "1": "0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F" }, "network_symbol_to_network_limits": { "ETH": { "symbol": "ETH", "limits": [ { "max_total_fee": 10000000000000000000, "max_priority_fee": 1000000000000 } ] } }, "currency_symbol_to_currency_limits": { "ETH": { "symbol": "ETH", "limits": [ { "fee_ratio": 1, "fee_cap": 132000000854001 } ] } } }
Body Parameters
- bodystartCollectorRequest
- FunctionDataobjectExample
{ "Config": { "Accounts": { "1": { "CollectorAddress": "0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F" } }, "CollectorId": "1", "CreationTime": 10, "CreatorUserId": "[email protected]", "Limits": { "Currencies": { "ETH": { "FeeCap": "132000000854001", "FeeRatio": "1" } }, "Networks": { "ETH": { "MaxPriorityFee": null, "MaxTotalFee": "10000000000000000000" } } }, "Name": "myCollector", "Type": 0 }, "InitiatorUserId": "[email protected]" }- ConfigobjectDescription
- AccountsobjectDescription
- 1object
- CollectorAddressstringExampleDescriptionDefault0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F
- CollectorIdstringExampleDescriptionDefault1
- CreationTimeintegerExampleDescriptionDefault10
- CreatorUserIdstringExampleDescriptionDefault
- LimitsobjectDescription
- CurrenciesobjectDescription
- ETHobject
- FeeCapstringExampleDescriptionDefault132000000854001
- FeeRatiostringExampleDescriptionDefault1
- NetworksobjectDescription
- ETHobject
- MaxPriorityFeestringDescription
- MaxTotalFeestringExampleDescriptionDefault10000000000000000000
- NamestringExampleDescriptionDefaultmyCollector
- TypeintegerDescriptionDefault0
- InitiatorUserIdstringExampleDescriptionDefault
- MetaMetaTokenstartCollector
- FunctionNamestringExampleDescriptionDefaultstartCollector
- RandomDatastringExampleDescriptionDefault288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229
- DestinationstringDescriptionDefaultb9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea
- TimestringExampleDescriptionDefault2021-02-07T18:37:46.948Z
- SourcestringDescriptionDefault048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99
- AccessTokenstringExampleDescriptionDefault51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087
Responses
200
- startCollectorResponse
- FunctionDataobject
- RunIdstringExampleDescriptionDefault01225c40-de1a-45ef-a69b-8747c6d87197
- StatusCodeintegerDescriptionDefault0
- MetaMetaResponse
- AccessTokenstringExampleDescriptionDefaulta3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6
- DestinationstringExampleDescriptionDefault042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622
- SourcestringExampleDescriptionDefaultdf4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355
- TimestringExampleDescriptionDefault2021-02-14 09:58:52.320
curl
curl --request POST \
--url 'http://1.1.1.1/startCollector?config=%22{%5Cn%20%20%5C%22account_id_to_collector_address%5C%22%3A%20{%5Cn%20%20%20%20%5C%221%5C%22%3A%20%5C%220xF1722F2c8Bab975C321321E2942E0dCb951B9C4F%5C%22%5Cn%20%20}%2C%5Cn%20%20%5C%22network_symbol_to_network_limits%5C%22%3A%20{%5Cn%20%20%20%20%5C%22ETH%5C%22%3A%20{%5Cn%20%20%20%20%20%20%5C%22symbol%5C%22%3A%20%5C%22ETH%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22limits%5C%22%3A%20[%5Cn%20%20%20%20%20%20%20%20{%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22max_total_fee%5C%22%3A%2010000000000000000000%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22max_priority_fee%5C%22%3A%201000000000000%5Cn%20%20%20%20%20%20%20%20}%5Cn%20%20%20%20%20%20]%5Cn%20%20%20%20}%5Cn%20%20}%2C%5Cn%20%20%5C%22currency_symbol_to_currency_limits%5C%22%3A%20{%5Cn%20%20%20%20%5C%22ETH%5C%22%3A%20{%5Cn%20%20%20%20%20%20%5C%22symbol%5C%22%3A%20%5C%22ETH%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22limits%5C%22%3A%20[%5Cn%20%20%20%20%20%20%20%20{%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22fee_ratio%5C%22%3A%201%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22fee_cap%5C%22%3A%20132000000854001%5Cn%20%20%20%20%20%20%20%20}%5Cn%20%20%20%20%20%20]%5Cn%20%20%20%20}%5Cn%20%20}%5Cn}%5Cn%22' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data-raw '{
"FunctionData": {
"Config": {
"Accounts": {
"1": {
"CollectorAddress": "0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F"
}
},
"CollectorId": "1",
"CreationTime": 10,
"CreatorUserId": "[email protected]",
"Limits": {
"Currencies": {
"ETH": {
"FeeCap": "132000000854001",
"FeeRatio": "1"
}
},
"Networks": {
"ETH": {
"MaxTotalFee": "10000000000000000000"
}
}
},
"Name": "myCollector"
},
"InitiatorUserId": "[email protected]"
},
"Meta": {
"FunctionName": "startCollector",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"FunctionData": {
"Config": {
"Accounts": {
"1": {
"CollectorAddress": "0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F"
}
},
"CollectorId": "1",
"CreationTime": 10,
"CreatorUserId": "[email protected]",
"Limits": {
"Currencies": {
"ETH": {
"FeeCap": "132000000854001",
"FeeRatio": "1"
}
},
"Networks": {
"ETH": {
"MaxTotalFee": "10000000000000000000"
}
}
},
"Name": "myCollector"
},
"InitiatorUserId": "[email protected]"
},
"Meta": {
"FunctionName": "startCollector",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("http://1.1.1.1/startCollector?config=\"{\\n \\\"account_id_to_collector_address\\\": {\\n \\\"1\\\": \\\"0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F\\\"\\n },\\n \\\"network_symbol_to_network_limits\\\": {\\n \\\"ETH\\\": {\\n \\\"symbol\\\": \\\"ETH\\\",\\n \\\"limits\\\": [\\n {\\n \\\"max_total_fee\\\": 10000000000000000000,\\n \\\"max_priority_fee\\\": 1000000000000\\n }\\n ]\\n }\\n },\\n \\\"currency_symbol_to_currency_limits\\\": {\\n \\\"ETH\\\": {\\n \\\"symbol\\\": \\\"ETH\\\",\\n \\\"limits\\\": [\\n {\\n \\\"fee_ratio\\\": 1,\\n \\\"fee_cap\\\": 132000000854001\\n }\\n ]\\n }\\n }\\n}\\n\"", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("http://1.1.1.1/startCollector?config=\"{\n \\"account_id_to_collector_address\\": {\n \\"1\\": \\"0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F\\"\n },\n \\"network_symbol_to_network_limits\\": {\n \\"ETH\\": {\n \\"symbol\\": \\"ETH\\",\n \\"limits\\": [\n {\n \\"max_total_fee\\": 10000000000000000000,\n \\"max_priority_fee\\": 1000000000000\n }\n ]\n }\n },\n \\"currency_symbol_to_currency_limits\\": {\n \\"ETH\\": {\n \\"symbol\\": \\"ETH\\",\n \\"limits\\": [\n {\n \\"fee_ratio\\": 1,\n \\"fee_cap\\": 132000000854001\n }\n ]\n }\n }\n}\n\"")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"FunctionData": {
"Config": {
"Accounts": {
"1": {
"CollectorAddress": "0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F"
}
},
"CollectorId": "1",
"CreationTime": 10,
"CreatorUserId": "[email protected]",
"Limits": {
"Currencies": {
"ETH": {
"FeeCap": "132000000854001",
"FeeRatio": "1"
}
},
"Networks": {
"ETH": {
"MaxTotalFee": "10000000000000000000"
}
}
},
"Name": "myCollector"
},
"InitiatorUserId": "[email protected]"
},
"Meta": {
"FunctionName": "startCollector",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
})
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "http://1.1.1.1/startCollector?config=\"{\\n \\\"account_id_to_collector_address\\\": {\\n \\\"1\\\": \\\"0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F\\\"\\n },\\n \\\"network_symbol_to_network_limits\\\": {\\n \\\"ETH\\\": {\\n \\\"symbol\\\": \\\"ETH\\\",\\n \\\"limits\\\": [\\n {\\n \\\"max_total_fee\\\": 10000000000000000000,\\n \\\"max_priority_fee\\\": 1000000000000\\n }\\n ]\\n }\\n },\\n \\\"currency_symbol_to_currency_limits\\\": {\\n \\\"ETH\\\": {\\n \\\"symbol\\\": \\\"ETH\\\",\\n \\\"limits\\\": [\\n {\\n \\\"fee_ratio\\\": 1,\\n \\\"fee_cap\\\": 132000000854001\\n }\\n ]\\n }\\n }\\n}\\n\""
payload = json.dumps({
"FunctionData": {
"Config": {
"Accounts": {
"1": {
"CollectorAddress": "0xF1722F2c8Bab975C321321E2942E0dCb951B9C4F"
}
},
"CollectorId": "1",
"CreationTime": 10,
"CreatorUserId": "[email protected]",
"Limits": {
"Currencies": {
"ETH": {
"FeeCap": "132000000854001",
"FeeRatio": "1"
}
},
"Networks": {
"ETH": {
"MaxTotalFee": "10000000000000000000"
}
}
},
"Name": "myCollector"
},
"InitiatorUserId": "[email protected]"
},
"Meta": {
"FunctionName": "startCollector",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// success
{
"FunctionData": {
"RunId": "01225c40-de1a-45ef-a69b-8747c6d87197",
"StatusCode": 0
},
"Meta": {
"AccessToken": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
"Destination": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
"Source": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
"Time": "2021-02-14 09:58:52.320"
}
}#IMPORTANT - can not be executed in Swagger UI
Calling this request can be used for retrieve information about collector's runs
- return - json with results and status code
- Possible status codes:
OK = 0,
ACCOUNT_EXISTS = 1,
IS_ALREADY_RUNNING = 2,
NOT_EXISTS = 3,
PERMISSION_DENIED = 4,
BAD_REQUEST = 400,
TECHNICAL_ERROR = 500