You need to include the api key as a parameter on every request with the 'key' string. You can include the parameters in the query string or the body of the request. Please note that all dates are expressed in the UTC timezone. We are available to help you if you are having issues using the api.
Accounts (3)
Balance Sheets (6)
Assets (24)
Retrieve Asset Transactions 1CR
GET https://www.investorclerk.com/api/assettransactions/
Delete Asset Transactions 1CR
DELETE https://www.investorclerk.com/api/assettransactions/
Retrieve Asset Dividend Reinvestment Plans 1CR
GET https://www.investorclerk.com/api/assetdrips/
Add Asset Dividend Reinvestment Plans 1CR
PUT https://www.investorclerk.com/api/assetdrips/
Edit Asset Dividend Reinvestment Plans 1CR
POST https://www.investorclerk.com/api/assetdrips/
Liabilities (20)
Retrieve Liability Transactions 1CR
GET https://www.investorclerk.com/api/liabilitytransactions/
Add Liability Transactions 1CR
PUT https://www.investorclerk.com/api/liabilitytransactions/
Edit Liability Transactions 1CR
POST https://www.investorclerk.com/api/liabilitytransactions/
Delete Liability Transactions 1CR
DELETE https://www.investorclerk.com/api/liabilitytransactions/
Retrieve Liability Periods 1CR
GET https://www.investorclerk.com/api/liabilityperiods/
Adjustments (4)
Balance Sheet Shares (7)
Currency Types
1 National
2 Commodity
3 Crypto
Activation Time
1 Basic Time
2 Advanced Time
3 Expert Time
4 Legend Time
Asset Types
1 Currency
2 Private Equity
3 Public Equity
4 Corporate Credit
5 Treasury
6 Commodity
7 Real Estate
8 Option
9 Future
10 Crypto
11 NFT
12 Loan
13 Art
14 Vehicule
15 Handbag
16 Watch
17 Jewelry
18 Footwear
19 Collectible
20 Public Index
Liability Types
1 Brokerage Margin
2 Line of Credit
3 Homeowner Line of Credit
4 Mortgage
5 Loan
6 Credit Card
Transaction Types
1 Buy
2 Sell
3 Short Sell
4 Cover
5 Deposit
6 Withdraw
7 Take
8 Give
9 Price Change
10 Rate Change
13 Earn
14 Drip
Item Sides
1 Revenue
2 Expense
Revenue Types
1 Dividend
2 Rent
3 Interest
4 Refund
Expense Types
1 Dividend
2 Fee
3 Interest
4 Maintenance
5 Capital Expenditure
6 Mortgage
7 Rent
Intervals
0 None
1 Daily
2 Weekly
3 Biweekly
4 Monthly
5 Bimonthly
6 Quarterly
7 Every four months
8 Biannually
9 Annually
Adjustment Types
1 Bonus
2 Dividend
3 Coupon
4 Rent
5 Interest
6 Refund
7 Fee
8 Maintenance
9 Depreciation
Share Displays
1 All
2 Absolute
3 Relative
Error Codes
1000 Request error.
1001 Not enough credits.
1002 Not enough Clerk Points.
1003 Invalid request method.
1004 Invalid key.
1005 Invalid request parameters.
1006 All balance sheets must be active to proceed.
1007 You must create a transfer id to send transfers.
1008 Invalid transfer recipient.
1009 A balance sheet involved in the request is expired.
1010 The name is already used.
1011 The symbol is already used.
1012 You cannot delete a converted asset or liability.
1013 Invalid transaction type.
1014 You cannot add a transaction after a relinquish transaction or before a receive transaction.
1015 The transaction quantity is above the available balance.
1016 The transaction would nullify a conversion. You have to delete the conversion before adding this transaction.
1017 You cannot delete a transaction on a converted asset or liability.
1018 You do not have the addon required to perform this request.
1019 The code is already used.
1020 The date range of your dividend reinvestment plan is already covered by another plan.