API

Sharesight

Cloud-based portfolio app for investors & accountants.
API Documentation
  • Introduction
  • Connect API
  • User API
  • Introduction
  • Configuring OAuth
  • Oauth 2.0 Example
  • Usage Limits
  • Sharesight Codes
  • Reference

User API - Codes

Market codes

code description
NZX New Zealand Stock Exchange
ASX Australian Stock Exchange
NYSE New York Stock Exchange
NASDAQ NASDAQ
LSE London Stock Exchange
FundAU Australian Fund
FundNZ New Zealand Fund
mFund mFund
EURONEXT Euronext St
CNSX Canadian Securities Exchange
TSE Toronto Stock Exchange
CVE Toronto Venture Exchange
HKG Hong Kong Stock Exchange
OTHER Other Market
SGX Singapore Stock Exchange
JSE Johannesburg Stock Exchange
FRA Deutsche Boerse
SWX Swiss Exchange
TYO Tokyo Stock Exchange
BIT Borsa Italiana Milan
BME Bolsa de Madrid
BSE Bombay Stock Exchange
NSE National Stock Exchange of India

Trade description codes

code description
BUY Buy
SELL Sell
SPLIT Split
BONUS Bonus
CONSOLD Consolidation
CANCEL Cancellation
CAPITAL_RETURN Return of Capital
OPENING_BALANCE Opening Balance
ADJUST_COST_BASE Adjust Cost Base
MERGE_CANCEL Merge (Cancel)
MERGE_BUY Merge (Buy)

Payout description codes

code description
DIV Dividend
REP Capital Repayment
INT Interest Payment
DIS Distribution

Country codes

code description
AF Afghanistan
AL Albania
DZ Algeria
AS American Samoa
AD Andorra
AO Angola
AI Anguilla
AQ Antarctica
AG Antigua and Barbuda
AR Argentina
AM Armenia
AW Aruba
_AS Asia
AU Australia
AT Austria
AZ Azerbaijan
BS Bahamas
BH Bahrain
BD Bangladesh
BB Barbados
BY Belarus
BE Belgium
BZ Belize
BJ Benin
BM Bermuda
BT Bhutan
BO Bolivia
BQ Bonaire, Sint Eustatius and Saba
BA Bosnia and Herzegovina
BW Botswana
BV Bouvet Island
BR Brazil
IO British Indian Ocean Territory
BN Brunei Darussalam
BG Bulgaria
BF Burkina Faso
BI Burundi
KH Cambodia
CM Cameroon
CA Canada
CV Cape Verde
KY Cayman Islands
CF Central African Republic
TD Chad
CL Chile
CN China
CX Christmas Island
CC Cocos (Keeling) Islands
CO Colombia
KM Comoros
CG Congo Republic of the Democratic
CD Congo-Brazzaville
CK Cook Islands
CR Costa Rica
HR Croatia (Hrvatska)
CU Cuba
CW Curaçao
CY Cyprus
CZ Czech Republic
DK Denmark
DJ Djibouti
DM Dominica
DO Dominican Republic
TP East Timor
TL East Timor
EC Ecuador
EG Egypt
SV El Salvador
GQ Equatorial Guinea
ER Eritrea
EE Estonia
ET Ethiopia
XS Europe
FK Falkland Islands (Malvinas)
FO Faroe Islands
FJ Fiji
FI Finland
FR France
GF French Guiana
PF French Polynesia
TF French Southern Territories
GA Gabon
GM Gambia
GE Georgia
DE Germany
GH Ghana
GI Gibraltar
GR Greece
GL Greenland
GD Grenada
GP Guadeloupe
GU Guam
GT Guatemala
GG Guernsey
GN Guinea
GW Guinea-Bissau
GY Guyana
HT Haiti
HM Heard and Mc Donald Islands
HN Honduras
HK Hong Kong
HU Hungary
IS Iceland
IN India
ID Indonesia
_IN International
IR Iran (Islamic Republic of)
IQ Iraq
IE Ireland
IM Isle of Man
IL Israel
IT Italy
CI Ivory Coast
JM Jamaica
JP Japan
JE Jersey
JO Jordan
KZ Kazakhstan
KE Kenya
KI Kiribati
KP Korea North
KR Korea South
KW Kuwait
KG Kyrgyzstan
LA Lao Peoples Democratic Republic
_LA Latin America
LV Latvia
LB Lebanon
LS Lesotho
LR Liberia
LY Libyan Arab Jamahiriya
LI Liechtenstein
LT Lithuania
LU Luxembourg
MO Macau
MK Macedonia
MG Madagascar
MW Malawi
MY Malaysia
MV Maldives
ML Mali
MT Malta
MH Marshall Islands
MQ Martinique
MR Mauritania
MU Mauritius
YT Mayotte
MX Mexico
FM Micronesia Federated States of
_ME Middle East
MD Moldova Republic of
MC Monaco
MN Mongolia
ME Montenegro
MS Montserrat
MA Morocco
MZ Mozambique
MM Myanmar
NA Namibia
NR Nauru
NP Nepal
NL Netherlands
AN Netherlands Antilles
NC New Caledonia
NZ New Zealand
NI Nicaragua
NE Niger
NG Nigeria
NU Niue
NF Norfolk Island
MP Northern Mariana Islands
NO Norway
OM Oman
PK Pakistan
PW Palau
PA Panama
PG Papua New Guinea
PY Paraguay
PE Peru
PH Philippines
PN Pitcairn
PL Poland
PT Portugal
PR Puerto Rico
QA Qatar
RE Reunion
RO Romania
RU Russian Federation
RW Rwanda
BL Saint Barthélemy
SH Saint Helena, Ascension and Tristan da Cunha
KN Saint Kitts
LC Saint Lucia
MF Saint Martin
PM Saint Pierre and Miquelon
VC Saint Vincent Grenadines
WS Samoa
SM San Marino
ST Sao Tome and Principe
SA Saudi Arabia
SN Senegal
RS Serbia
SC Seychelles
SL Sierra Leone
SG Singapore
SX Sint Maarten
SK Slovakia (Slovak Republic)
SI Slovenia
SB Solomon Islands
SO Somalia
ZA South Africa
GS South Georgia and the South Sandwich Islands
SS South Sudan
ES Spain
LK Sri Lanka
PS State of Palestine
SD Sudan
SR Suriname
SJ Svalbard and Jan Mayen Islands
SZ Swaziland
SE Sweden
CH Switzerland
SY Syrian Arab Republic
TW Taiwan
TJ Tajikistan
TZ Tanzania
TH Thailand
TG Togo
TK Tokelau
TO Tonga
TT Trinidad and Tobago
TN Tunisia
TR Turkey
TM Turkmenistan
TC Turks and Caicos Islands
TV Tuvalu
UG Uganda
UA Ukraine
AE United Arab Emirates
GB United Kingdom
US United States
UM United States Minor Outlying Islands
UN Unknown
UY Uruguay
UZ Uzbekistan
VU Vanuatu
VA Vatican City State (Holy See)
VE Venezuela
VN Vietnam
VG Virgin Islands (British)
VI Virgin Islands (US)
WF Wallis and Futuna Islands
EH Western Sahara
YE Yemen
ZM Zambia
ZW Zimbabwe
AX Ã…land Islands

Currency codes

code description
NZD New Zealand Dollars
AUD Australian Dollars
EUR Euros
GBP Pounds Sterling
USD USD
HKD HKD
CAD Canadian Dollar
JPY Japanese Yen
AFN Afghani
ALL Lek
DZD Algerian Dinar
XCD East Caribbean Dollar
ARS Peso
AMD Dram
ANG Netherlands Antilles Guilder
AZN Manat
BSD Bahamian Dollar
BHD Bahraini Dinar
BDT Taka
BBD Barbadian Dollar
BYR Belarus Ruble
BZD Belizean Dollar
XOF CFA Franc BCEAO
BMD Bermudian Dollar
INR Indian Rupee
BOB Boliviano
BWP Pula
NOK Norwegian Krone
BRL Brazil Real
BND Bruneian Dollar
BGN Lev
BIF Burundi Franc
KHR Riel
XAF CFA Franc BEAC
CVE Escudo
KYD Caymanian Dollar
CLP Chilean Peso
CNY Yuan Renminbi
COP Peso
KMF Comoran Franc
CDF Congolese Frank
CRC Costa Rican Colon
HRK Croatian Dinar
CUP Cuban Peso
CYP Cypriot Pound
CZK Koruna
DKK Danish Krone
DJF Djiboutian Franc
DOP Dominican Peso
IDR Indonesian Rupiah
ECS Sucre
EGP Egyptian Pound
SVC Salvadoran Colon
ETB Ethiopian Birr
EEK Estonian Kroon
FKP Falkland Pound
FJD Fijian Dollar
XPF CFP Franc
GMD Dalasi
GEL Lari
GIP Gibraltar Pound
GTQ Quetzal
GNF Guinean Franc
GYD Guyanaese Dollar
HTG Gourde
HNL Lempira
HUF Forint
ISK Icelandic Krona
IRR Iranian Rial
IQD Iraqi Dinar
ILS Shekel
JMD Jamaican Dollar
JOD Jordanian Dinar
KZT Tenge
KES Kenyan Shilling
KPW Won
KRW Won
KWD Kuwaiti Dinar
KGS Som
LAK Kip
LVL Lat
LBP Lebanese Pound
LSL Loti
LRD Liberian Dollar
LYD Libyan Dinar
CHF Swiss Franc
LTL Lita
MOP Pataca
MKD Denar
MGA Malagasy Franc
MWK Malawian Kwacha
MYR Ringgit
MVR Rufiyaa
MTL Maltese Lira
MRO Ouguiya
MUR Mauritian Rupee
MXN Peso
MDL Leu
MNT Tugrik
MAD Dirham
MZN Metical
MMK Kyat
NAD Dollar
NPR Nepalese Rupee
NIO Cordoba Oro
NGN Naira
OMR Sul Rial
PKR Pakistani Rupee
PAB Balboa
PGK Kina
PYG Guarani
PEN Nuevo Sol
PHP Peso
PLN Zloty
QAR Rial
RON Leu
RUB Ruble
RWF Rwanda Franc
STD Dobra
SAR Riyal
SCR Seychellois Rupee
SLL Leone
SGD Dollar
SKK Koruna
SBD Solomon Islands Dollar
SOS Shilling
ZAR Rand
LKR Sri Lankan Rupee
SDG Dinar
SRD Surinamese Guilder
SZL Lilangeni
SEK Krona
SYP Syrian Pound
TWD Dollar
TJS Tajikistan Ruble
TZS Shilling
THB Baht
TOP Palanga
TTD Trinidad and Tobago Dollar
TND Tunisian Dinar
TRY Lira
TMT Manat
UGX Shilling
UAH Hryvnia
AED Dirham
UYU Peso
UZS Som
VUV Vatu
VEF Bolivar
VND Dong
YER Rial
ZMK Kwacha
ZWD Zimbabwe Dollar

Sale allocation method codes

code description
Australia
fifo First In, First Out
lifo Last In, First Out
maximise_cr Maximise Gain
minimise_cr Minimise Gain
ss_minimise Minimise CGT
defaultPortfolio Default
Canada
average Average Cost
defaultPortfolio Default
New Zealand
fifo First In, First Out
lifo Last In, First Out
maximise_cr Maximise Gain
minimise_cr Minimise Gain
defaultPortfolio Default
International
fifo First In, First Out
lifo Last In, First Out
maximise_cr Maximise Gain
minimise_cr Minimise Gain
defaultPortfolio Default
If you have any questions or concerns, please contact support@sharesight.com.