Skip to content
Xtrendence edited this page May 6, 2021 · 8 revisions

API Documentation

/api/account/

POST login.php

Parameter Type Notes
token String Only required if platform and password are empty.
platform String Only required if token is empty. Must be "app", "desktop", or "web".
password String Only required if token is empty.

GET logout.php

Parameter Type Notes
token String -
platform String -

PUT update.php

Parameter Type Notes
currentPassword String -
newPassword String -

/api/activity

POST create.php

Parameter Type Notes
token String -
id String CoinGecko coin ID
symbol String Coin ticker.
date String Must be parsable by PHP's strtotime().
type String Must be "buy", "sell", or "transfer".
amount Int -
fee Int -
notes String -
exchange String Only usable if type is "buy" or "sell".
pair String Only usable if type is "buy" or "sell".
price Int Only usable if type is "buy" or "sell".
from String Only usable if type is "transfer".
to String Only usable if type is "transfer".

DELETE delete.php

Parameter Type Notes
token String -
txID String -

GET export.php

Parameter Type Notes
token String -

POST import.php

Parameter Type Notes
token String -
rows Array Order: txID (can be left as "-"), id, symbol, date, type, amount, fee, notes, exchange, pair, price, from, to

GET read.php

Parameter Type Notes
token String -

PUT update.php

Parameter Type Notes
token String -
txID String -
id String CoinGecko coin ID
symbol String Coin ticker.
date String Must be parsable by PHP's strtotime().
type String Must be "buy", "sell", or "transfer".
amount Int -
fee Int -
notes String -
exchange String Only usable if type is "buy" or "sell".
pair String Only usable if type is "buy" or "sell".
price Int Only usable if type is "buy" or "sell".
from String Only usable if type is "transfer".
to String Only usable if type is "transfer".

/api/coins/

GET read.php

Parameter Type Notes
token String -
symbol String Coin ticker. If used, "id" must be left empty.
id String CoinGecko coin ID. If used, "symbol" must be left empty".

/api/holdings/

POST create.php

Parameter Type Notes
token String -
id String CoinGecko coin ID.
symbol String Coin ticker.
amount Int -

DELETE delete.php

Parameter Type Notes
token String -
id String -

GET export.php

Parameter Type Notes
token String -

POST import.php

Parameter Type Notes
token String -
rows Array Order: id, symbol, amount

GET read.php

Parameter Type Notes
token String -

PUT update.php

Parameter Type Notes
token String -
id String CoinGecko coin ID.
amount Int -

/api/settings/

GET read.php

Parameter Type Notes
token String -

PUT update.php

Parameter Type Notes
token String -
key String -
value String -
Clone this wiki locally