Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get Benchmarks
This request returns the performance reporting benchmarks that are available for a member.
Request URL
Syntax | GET /restapi/members/{loginid}/benchmarks |
---|---|
Example URL | https://api.uat.foliofn.com/restapi/members/testusername/benchmarks |
Response Data Fields
Field | Description |
---|---|
benchmarkOid | The unique identifier of the benchmark. |
benchmarkType | The type of the standard benchmark. “S” for ticker symbol; “I” for index benchmark; “C” for custom benchmark. |
customBenchmarkType | The type of the custom benchmark. “I” for indexes/securities; “T” for target return. Standard benchmark does not have this field. |
name | The name of the benchmark. |
ticker | The ticker of the benchmark. Custom benchmark does not have a ticker field. |
popular | The indicator of a benchmark’s popularity. |
Response Example
HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://api.uat.foliofn.com/restapi/ members/testusername/benchmarks
Content-Type: text/html; charset=iso-8859-1
Content-Length: 0
Date: Fri, 21 Feb 2014 18:34:13 GMT
[
{
"benchmarkOid":"47",
"benchmarkType":"I",
"name":"Dow Jones U.S. Moderate (Price Return)",
"popular":false,
"ticker":"^P60US"
},
{
"benchmarkOid":"43",
"benchmarkType":"I",
"name":"PIMCO Intermediate Municipal Bond ETF",
"popular":false,
"ticker":"MUNI"
},
{
"benchmarkOid":"24",
"benchmarkType":"I",
"name":"Russell Mid Cap Growth (Total Return)",
"popular":true,
"ticker":"^RMCCGTR"
},
{
"benchmarkOid":"2412123123123123",
"benchmarkType":"C",
"customBenchmark":"T",
"name":"5% Return",
"popular":false,
}
]