top

Security Types

View all available security types used throughout SWFI.

Retrieve all security types

Retrieve a list of security types with no pagination. Security Types collection is referential to other collections.

Get/security-types

Path Parameters

No query or path parameters are needed to get a list of security types.
List Security Types
curl -v -X GET https://api.swfi.com/v1/sectors \ 
-H "Accept: application/json" \ 
-H "Authorization: $API_KEY"

Success Response

HTTP Status 200
data
TYPEobject[]
Array of strings.

total_items
TYPEinteger
The total length of the data object.
Example response
{
  "data": [
    "Asset-Backed Security",
    "Bond",
    "Concession",
    "Convertible Bond",
    "Convertible Preferred Stock",
    "Convertible Preferred Units",
    "Credit Facility",
    "Debenture",
    "Debt With Warrants",
    "Digital Token",
    "Exchange Traded Fund",
    "Forward Contract",
    "Fund Units",
    "Futures",
    "Global Depositary Receipt",
    "Green Bond",
    "Leasehold Interest",
    "Limited Partnership",
    "Loan",
    "Mandatory Convertible Security",
    "Mortgage-Backed Security",
    "Notes",
    "Ordinary Shares",
    "Preferred Shares",
    "Real Property",
    "Royalty",
    "Separate Account",
    "Subordinated Notes",
    "Term Loan",
    "Warrants"
  ],
  "total_items": 30
}

Error Response

message
TYPEstring
A short, human-readable summary of the problem type.

status
TYPEinteger
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurance of the problem.
Example response
{
  "errors": [
      {
          "path": "/v1/aum/:_id",
          "message": "Not Found"
      }
  ],
  "status": 404
}
Documentation as of 10/19/2022