GET v1/Equities/Identifier/{id}/{identifierValue}

Description

Retrieve an equity for an identifier type with WSO ID of {id} and value of {identifierValue}.

Base Url

https://services.wsoweb.com/


Rest Call Syntax


GET SecurityMaster/v1/Equities/Identifier/{id}/{identifierValue}

GET SecurityMaster/v1/Equities/Identifier/{id}/{identifierValue}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of identifier type

integer

Required

identifierValue

Identifier value

string

Required




Response Information



Equity

Name

Description

Type

Additional Information

AssetClassId

The class of the asset by ID value

integer

CountryId

The legal country of this asset by ID value

integer

CurrencyCode

The ISO code for currency

string

DataFeedId

The DataFeed of equity

integer

Description

The description/name of the asset

string

Dividends

The hateoas link to dividends

EquityType

The type of equity

string

Exchange

The name of the exchange where the equity is traded

string

GuarantorId

The guarantor for the asset by ID value

integer

HasAttachedWarrants

The flag indicating if the asset has attached warrants

boolean

HasFXRisk

The flag indicating if the asset has foreign exchange risk

boolean

HasIdentifiers

A flag indicating if the asset has any identifiers

boolean

HasRatings

A flag indicating if the asset has ratings

boolean

HolidayCalendarId

The holiday calendar for the asset by ID value

integer

Id

The WSO ID of the asset

integer

Identifiers

The hateoas link to Identifiers

InsurerId

The insurer of the asset by ID value

integer

IsConvertible

The flag indicating if the asset is convertible

boolean

IsDeleted

The flag indicating if the asset has been soft deleted

boolean

IsDRIP

The flag indicating if the asset has a Dividend Reinvestment Plan (DRIP)

boolean

IsEmergingMarket

The flag indicating if the asset is from an emerging market

boolean

IsGuaranteed

The flag indicating if the asset is guaranteed by another entity

boolean

IsPrivate

The flag indicating if the asset is a private security

boolean

IsRestructured

The flag indicating if the security has been restructured since it was initially issued

boolean

IsStructuredFinanceObligation

The flag indicating if the asset belongs to a structured finance obligation

boolean

IssueDate

The date that the asset was officially issued

date

IssuePrice

The original price at which the asset was issued

decimal number

Issuer

A link to retrieve the Issuer

IssuerId

The WSO ID of the issuer

integer

IsSynthetic

The flag indicating if this a synthetic security

boolean

Links

The Hateoas links related to the asset

Collection of Link

Notes

Notes regarding the asset

string

OptionExpirationDate

The expiration date of the option period

date

OptionStrikePrice

The strike price of the option

decimal number

OptionType

The type of option

string

Ratings

The hateoas link to Ratings

RegistrationType

The registration type

string

SeniorityId

The seniority level of the asset by ID value

integer

SharesOffered

The number of shares offered at issuance

integer

Splits

The hateoas link to splits

TransferAgentId

The transfer agent listed by ID value

integer

Udfs

The hateoas link to Udfs

UnderwriterId

The lead underwriter listed by ID value

integer




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "assetClassId": 1,
  "countryId": 1,
  "currencyCode": "sample string 3",
  "description": "sample string 4",
  "equityType": "sample string 5",
  "exchange": "sample string 6",
  "guarantorId": 7,
  "hasFXRisk": true,
  "holidayCalendarId": 1,
  "insurerId": 9,
  "hasAttachedWarrants": true,
  "isConvertible": true,
  "isDeleted": true,
  "isDRIP": true,
  "isEmergingMarket": true,
  "isGuaranteed": true,
  "isPrivate": true,
  "isRestructured": true,
  "isStructuredFinanceObligation": true,
  "issuer": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "issueDate": "2024-11-23T01:23:43.570745-06:00",
  "issuePrice": 1.1,
  "isSynthetic": true,
  "notes": "sample string 20",
  "optionExpirationDate": "2024-11-23T01:23:43.570745-06:00",
  "optionStrikePrice": 22.1,
  "optionType": "sample string 23",
  "registrationType": "sample string 24",
  "seniorityId": 1,
  "sharesOffered": 1,
  "transferAgentId": 25,
  "underwriterId": 26,
  "hasIdentifiers": true,
  "hasRatings": true,
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ],
  "dividends": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "splits": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "identifiers": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "ratings": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "udfs": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "issuerId": 30,
  "dataFeedId": 31
}

application/xml, text/xml

Sample:
<Equity xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssetClassId>1</AssetClassId>
  <CountryId>1</CountryId>
  <CurrencyCode>sample string 3</CurrencyCode>
  <DataFeedId>31</DataFeedId>
  <Description>sample string 4</Description>
  <Dividends>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Dividends>
  <EquityType>sample string 5</EquityType>
  <Exchange>sample string 6</Exchange>
  <GuarantorId>7</GuarantorId>
  <HasAttachedWarrants>true</HasAttachedWarrants>
  <HasFXRisk>true</HasFXRisk>
  <HasIdentifiers>true</HasIdentifiers>
  <HasRatings>true</HasRatings>
  <HolidayCalendarId>1</HolidayCalendarId>
  <Id>1</Id>
  <Identifiers>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Identifiers>
  <InsurerId>9</InsurerId>
  <IsConvertible>true</IsConvertible>
  <IsDRIP>true</IsDRIP>
  <IsDeleted>true</IsDeleted>
  <IsEmergingMarket>true</IsEmergingMarket>
  <IsGuaranteed>true</IsGuaranteed>
  <IsPrivate>true</IsPrivate>
  <IsRestructured>true</IsRestructured>
  <IsStructuredFinanceObligation>true</IsStructuredFinanceObligation>
  <IsSynthetic>true</IsSynthetic>
  <IssueDate>2024-11-23T01:23:43.570745-06:00</IssueDate>
  <IssuePrice>1.1</IssuePrice>
  <Issuer>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Issuer>
  <IssuerId>30</IssuerId>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <Notes>sample string 20</Notes>
  <OptionExpirationDate>2024-11-23T01:23:43.570745-06:00</OptionExpirationDate>
  <OptionStrikePrice>22.1</OptionStrikePrice>
  <OptionType>sample string 23</OptionType>
  <Ratings>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Ratings>
  <RegistrationType>sample string 24</RegistrationType>
  <SeniorityId>1</SeniorityId>
  <SharesOffered>1</SharesOffered>
  <Splits>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Splits>
  <TransferAgentId>25</TransferAgentId>
  <Udfs>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Udfs>
  <UnderwriterId>26</UnderwriterId>
</Equity>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.