Links

Custody

get
https://api.sfox.com/v1
/whitelisted-addresses
Fetching whitelisted withdrawal addresses

Response Body

Key
Description
alias
Custom alias you have assigned to the address
address
Whitelisted withdraw address
currency_symbol
Currency that can be withdrawn to the address
date_created
ISO date string
date_updated
ISO date string
Shell
NodeJS
Python
curl -H 'Authorization: Bearer <API_TOKEN>' \
https://api.sfox.com/v1/whitelisted-addresses
const axios = require('axios');
axios({
method: 'get',
url: 'https://api.sfox.com/v1/whitelisted-addresses',
headers: {
'Authorization': 'Bearer <API_KEY>'
}
}).then(response => {
console.log(response)
}).catch(err => {
console.error(err)
});
import requests
data = requests.get(
"https://api.sfox.com/v1/whitelisted-addresses",
headers={
"Authorization": "Bearer <API_KEY>",
}
)
print(data)
post
https://api.sfox.com/v1
/whitelisted-addresses
Create whitelist withdrawal address
Shell
NodeJS
Python
curl -X POST \
-H 'Content-type: application/json' \
-H 'Authorization: Bearer < API_TOKEN >' \
--data '{ "alias": "Satoshis Fund",
"currency_symbol": "btc",
"address": "1NLqQmwkGxxQmzS9uwtCGXxbxrcNW4FpYp" }' \
https://api.sfox.com/v1/whitelisted-addresses
const axios = require('axios');
axios({
method: 'post',
url: 'https://api.sfox.com/v1/whitelisted-addresses',
headers: {
'Authorization': 'Bearer <API_KEY>'
},
data: {
alias: 'Satoshis Fund',
currency_symbol: 'btc',
address: '1NLqQmwkGxxQmzS9uwtCGXxbxrcNW4FpYp'
}
}).then(response => {
console.log(response)
}).catch(err => {
console.error(err)
});
import requests
data = requests.post(
"https://api.sfox.com/v1/whitelisted-addresses",
headers={
"Authorization": "Bearer <API_KEY>",
},
data={
"alias": "Satoshis Fund",
"currency_symbol": "btc",
"address": "1NLqQmwkGxxQmzS9uwtCGXxbxrcNW4FpYp"
}
)
print(data)
get
https://api.sfox.com/v1
/approval-rules
Fetching account approval rules
Shell
NodeJS
Python
curl -H 'Authorization: Bearer <API_TOKEN>' \
https://api.sfox.com/v1/approval-rules
const axios = require('axios');
axios({
method: 'get',
url: 'https://api.sfox.com/v1/approval-rules',
headers: {
'Authorization': 'Bearer <API_KEY>'
}
}).then(response => {
console.log(response)
}).catch(err => {
console.error(err)
});
import requests
data = requests.get(
"https://api.sfox.com/v1/approval-rules",
headers={
"Authorization": "Bearer <API_KEY>",
}
)
print(data)
post
https://api.sfox.com/v1
/approval-rules
Creating approval rules
Shell
NodeJS
Python
curl -X POST \
-H 'Content-type: application/json' \
-H 'Authorization: Bearer <API_TOKEN>' \
--data '{ "rule_type": "WITHDRAW",
"required_approvals": 2,
"threshold": 100 }' \
https://api.sfox.com/v1/approval-rules
const axios = require('axios');
axios({
method: 'post',
url: 'https://api.sfox.com/v1/approval-rules',
headers: {
'Authorization': 'Bearer <API_KEY>'
},
data: {
rule_type: "WITHDRAW",
required_approvals: 2,
threshold: 100
}
}).then(response => {
console.log(response)
}).catch(err => {
console.error(err)
});
import requests
data = requests.post(
"https://api.sfox.com/v1/approval-rules",
headers={
"Authorization": "Bearer <API_KEY>",
},
data={
"rule_type": "WITHDRAW",
"required_approvals": 2,
"threshold": 100
}
)
print(data)
patch
https://api.sfox.com/v1
/approval-rules/:id
Editing approval rules
Shell
NodeJS
Python
curl -X PATCH \
-H 'Content-type: application/json' \
-H 'Authorization: Bearer <API_TOKEN>' \
--data '{ "required_approvals": 3 , "threshold": 500 }' \
https://api.sfox.com/v1/approval-rules/1
const axios = require('axios');
axios({
method: 'patch',
url: 'https://api.sfox.com/v1/approval-rules/1',
headers: {
'Authorization': 'Bearer <API_KEY>'
},
data: {
required_approvals: 3 ,
threshold: 500
}
}).then(response => {
console.log(response)
}).catch(err => {
console.error(err)
});
import requests
data = requests.patch(
"https://api.sfox.com/v1/approval-rules/1",
headers={
"Authorization": "Bearer <API_KEY>",
},
data={
"required_approvals": 3,
"threshold": 500
}
)
print(data)
get
https://api.sfox.com/v1
/approvals
Fetching approval requests
Shell
NodeJS
Python
curl -H 'Authorization: Bearer <API_TOKEN>' \
https://api.sfox.com/v1/approvals
const axios = require('axios');
axios({
method: 'get',
url: 'https://api.sfox.com/v1/approvals',
headers: {
'Authorization': 'Bearer <API_KEY>'
}
}).then(response => {
console.log(response)
}).catch(err => {
console.error(err)
});
import requests
data = requests.get(
"https://api.sfox.com/v1/approvals",
headers={
"Authorization": "Bearer <API_KEY>",
}
)
print(data)
post
https://api.sfox.com/v1
/approvals/:id
Responding to an approval request
Shell
NodeJS
Python
curl -X POST \
-H 'Content-type: application/json' \
-H 'Authorization: Bearer <API_TOKEN>' \
--data '{ "approve": true}' \
https://api.sfox.com/v1/approvals/1
const axios = require('axios');
axios({
method: 'post',
url: 'https://api.sfox.com/v1/approvals/1',
headers: {
'Authorization': 'Bearer <API_KEY>'
},
data: {
approve: true
}
}).then(response => {
console.log(response)
}).catch(err => {
console.error(err)
});
import requests
data = requests.post(
"https://api.sfox.com/v1/approvals/1",
headers={
"Authorization": "Bearer <API_KEY>",
},
data={
"approve": True
}
)
print(data)