Reference Data API Contracts

Table of Contents


Access API

These contracts are accessible by the Public Party. Refer to Contracts Overview for further details.

Active Contract Set of Public Contracts

The code fragment below uses the public Party ID, to retrieve all active public contracts, the code can be incorporated into a client’s application to access API contracts with public access.

For CDE the public party ID is ‘public’, note this will be replaced in ITE1 and the use of the word public is for specific testing in CDE.


String publicParty = "<insert publicPartyID here>";
Flowable<GetActiveContractsResponse> activeContracts = client.getActiveContractSetClient().getActiveContracts(
new FiltersByParty(Collections.singletonMap(publicParty, NoFilter.instance)),true);



Module DA.ASX.API.Actor.Actor_V001

Templates

template ActorStandardView

FieldTypeDescription
operatorPartyThe operator
publicPartyPartyThe party for public disclosure
uicActorIdThe actor's UIC
bicOptional TextThe actor's BIC
  • Choice Archive

Data Types

type ActorId= Text

type C= ContractId T

type K= ActorId

type T= ActorStandardView

Module DA.ASX.API.Reference.BusinessDate_V001

Templates

template BusinessDate

FieldTypeDescription
operatorPartyThe system operator
currentBusinessDateDateCurrent business date as per the C&S system business calendar (ASX: Current Business Date)
publicPartyPartyThe party for public disclosure
  • Choice Archive

Module DA.ASX.API.Reference.Calendar_V001

Templates

template Calendar

FieldTypeDescription
operatorPartyThe system operator
calendar[CalendarDay]List of calendar dates
publicPartyPartyThe party for public disclosure
  • Choice Archive

Data Types

data CalendarDay

CalendarDay

FieldTypeDescription
dateDateDate received in the calendar message
isBusinessDateBoolSpecifies if a date is a valid Business Date (T) or a weekend/holiday (F)

Module DA.ASX.API.Security.Issuer_V001

Templates

template Issuer

FieldTypeDescription
operatorPartyThe operator
issuerActorIdKIssuer's Actor Id (ASX: Issuer Actor Id)
companyIdTextCompany Id, provided externally by ASX. (ASX: Company Id)
issuerFullNameTextIssuer Full Name (ASX: Issuer Full Name)
issuerCodeTextIssuer Code (ASX: Issuer Code)
publicPartyPartyThe party for public disclosure
  • Choice Archive

Data Types

type C= ContractId T

type K= Text

type T= Issuer

Module DA.ASX.API.Security.Security_V001

Templates

template SecurityStandardView

FieldTypeDescription
operatorPartyThe operator
publicPartyPartyThe party for public disclosure
securityIdKUnique Security Identifier, provided externally by ASX. (ASX: Security Id)
productIdProductId_V001.ProductIdUnique Product Identifier, provided externally by ASX. (ASX: Product Id)
apirCodeOptional TextThe APIR code of the security (ASX: APIR Code)
securityCodeOptional TextThe market ticker for the security (ASX: Security Code)
isinOptional TextThe ISIN bound to the security (ASX: ISIN)
derivedMicText
issuerActorIdTextThe UIC of the issuer actor for which the security is associated to. (ASX: Issuer Actor Id)
deferredDeliveryIndicatorBoolWhether security is currently in a deferred delivery period (ASX: Deferred Delivery Indicator)
nettingEligibleBoolDenotes whether the security can be netted within an NBO (ASX: Netting Eligible)
issuerSponsoredSubRegistryBoolDenotes whether the Issuer maintains a sub-register for the security (ASX: Issuer Sponsored Sub-Register)
firstListedDateOptional DateFirst Listed Date (ASX: First Listed Date)
lastListedDateOptional DateThe date the security was de-listed, if relevant (ASX: Last Listed Date)
firstSettlementDateOptional DateFirst Settlement Date (ASX: First Settlement Date)
instrumentClassificationSecurityClassification_V001.SecurityClassificationThe classification of the security for clearance and settlement (ASX: Instrument Classification)
securitySubRegisterStateSecuritySubRegisterState_V001.SecuritySubRegisterStateSecurity Sub-Register State (ASX: Security Sub-Register State)
settlementCategorySettlementCategory_V001.SettlementCategorySettlement Category (ASX: Settlement Category)
unitPrecisionIntUnit Precision (ASX: Unit Precision)
lastActiveDateOptional DateThe last date until when the security remains active. Last Active Date indicates the date when the security 'ASX CODE' remains in use. 'Last Active Date' in ReferencePoint feed can be used by subscribers to remove ASX Codes from systems. (ASX: Last Active Date)
despatchDateOptional DateThe date upon which the issuing entity will allot securities and either issue certificates or enter the securities into the security holder's uncertificated holding. For securities that are tradable the Issue Date marks the end of a deferred settlement period. (ASX: Issue Date)
fundStatusCodeOptional Text
  • Choice Archive

Data Types

type C= ContractId T

type K= SecurityId_V001.T

type T= SecurityStandardView

Module DA.ASX.API.Security.SecurityClassification_V001

Data Types

data SecurityClassification

The classification of the security based on its type.

Equity

(ASX: EQY)

MFund

Equity with security type code MFund (ASX: 38) or MFundHighDenom (ASX: 35). (ASX: EQY)

FixedIncome

(ASX: FIN)

ConvertibleNote

(ASX: CNV)

CompanyOption

(ASX: COP)

Warrant

(ASX: WAR)

RollingWarrant

When instrument type is Warrant, and the SPEC_FEATURE_1_CODE contains either (ASX: 4) or (ASX: 5). ^ (ASX: WAR)

Module DA.ASX.API.Security.SecuritySubRegisterState_V001

Data Types

data SecuritySubRegisterState

Suspended

Security is suspended

Open

Security is open

Closed

Security is closed

Archived

Security is achived

Module DA.ASX.API.Security.SettlementCategory_V001

Data Types

data SettlementCategory

Standard

MFund

Module DA.ASX.API.Security.SecurityId_V001

Data Types

type SecurityId= Text

type T= SecurityIdThe system-allocated Security Id

Module DA.ASX.API.Security.ProductId_V001

Data Types

data ProductId

Security

Entitlement

Cash

Module DA.ASX.API.AssetServicing.CorporateActionEvent_V001

Templates

template CorporateActionEventStandardView

operatorPartyThe operator
publicPartyPartypublic party
corporateActionEventIdCorporateActionEventIdUnique numeric identifier of a corporate action allocated by ASX (ASX: Corporate Action Event Id)
eventTypeCorporateActionEventType_V001.CorporateActionEventTypeType of corporate action event (ASX: Event Type Code)
buybackTypeOptional BuybackType_V001.BuybackTypeType of buyback for repurchases (ASX: Buyback Type)
corporateActionSubTypeOptional CorporateActionSubType_V001.CorporateActionSubTypeLinked event type (ASX: Corporate Action Sub-Type)
bomTypeOptional BomType_V001.BomTypeBasis of movement type (ASX: BOM Type)
underlyingSecurityIdSecurity.SecurityId_V001.SecurityIdUnique identifier of the underlying security (ASX: Underlying Security Id)
intermediateSecurityIdOptional Security.SecurityId_V001.SecurityIdUnique identifier of the intermediate security for rights corporate actions (ASX: Intermediate Security Id)
intermediateSecurityPostingDateOptional DateIntermediate security posting date (ASX: Intermediate Security Posting Date)
intermediateSecurityExpiryDateOptional DateIntermediate security expiry date (ASX: Intermediate Security Expiry Date)
exDateOptional DateEx date (ASX: Ex Date)
recordDateOptional DateRecord date (ASX: Record Date)
paymentDateOptional DatePayment date (ASX: Payment Date)
effectiveDateOptional DateDate on which change of issuer code, issuer name, security code, or security name comes into effect (ASX: Effective Date)
offerTypeOptional OfferType_V001.OfferTypeOffer type for takeovers (ASX: Offer Type)
eventStageOptional CorporateActionEventStage_V001.CorporateActionEventStageEvent stage for takeovers or other bids (ASX: Event Stage)
statusCorporateActionStatus_V001.CorporateActionStatusCurrent status of the corporate action (ASX: Corporate Action Status)
cancellationReasonOptional CorporateActionCancellationReason_V001.CorporateActionCancellationReasonReason for cancellation (ASX: Cancellation Reason Code)
  • Choice Archive

Data Types

type CorporateActionEventId = Text

Module DA.ASX.API.AssetServicing.CorporateActionEventStage_V001

Data Types

data CorporateActionEventStage

Conditional

COND

Halt

HALT

Lapsed

LAPS

Unconditional

UCON

Withdrawn

WITH

Closed

CLOS

Module DA.ASX.API.AssetServicing.CorporateActionEventType_V001

Data Types

data CorporateActionEventType

BonusIssue

Call

CashDividend

NoteConversion

DecreaseInValue

DividendOption

DividendReinvestment

IssuerClassCode

InterestPayment

InterestPaymentWithPrincipal

Merger

PriorityIssue

RepurchaseOffer

ReverseStockSplit

RightsIssue

ScripDividend

ScripDividendInterest

StockSplit

Takeover

OptionsConversion

WarrantRollover

OtherBid

Module DA.ASX.API.AssetServicing.BomType_V001

Data Types

type BomType= Text

Module DA.ASX.API.AssetServicing.CorporateActionCancellationReason_V001

Data Types

data CorporateActionCancellationReason

ProcessingError

(ASX: PROC)

Withdrawn

(ASX: WITH)

Module DA.ASX.API.AssetServicing.BuybackType_V001

Data Types

data BuybackType

EqualAccess

EQAC

OnMarket

ONMK

Module DA.ASX.API.AssetServicing.OfferType_V001

Data Types

data OfferType

OffMarket

OFFM

Proportional

PRPL

TakeoverOnMarket

ONMK

Module DA.ASX.API.AssetServicing.OptionStatus_V001

Data Types

data OptionStatus

Option status of corporate action bidding option

Cancelled

(ASX: CANC)

Inactive

(ASX: INTV)

Module DA.ASX.API.AssetServicing.OptionType_V001

Data Types

data OptionType

Option type of corporate action bidding option

Securities

SECU

Cash

CASH

CashAndSecurities

CASE

BonusSharePlan

BSPL

NoAction

NOAC

Module DA.ASX.API.AssetServicing.CorporateActionStatus_V001

Data Types

data CorporateActionStatus

Active

Completed

Cancelled

Module DA.ASX.API.AssetServicing.CorporateActionSubType_V001

Data Types

data CorporateActionSubType

Bonus

BNUS

AttachingOption

AOPT

ExRightOfExercise

EXRE

NonRenounceableIssue

NRNI

RenounceableIssue

RENI

SharePurchasePlan

SHPP

PriorityIssue

PRNP

IssuerCodeAndNameChange

INCC

IssuerNameChangeOnly

NAMC

ClassChange

CLSC

Rolling

ROLL

OptionsExpiry

EXPR

Module DA.ASX.API.AssetServicing.ExOrCum_V001

Data Types

data ExOrCum

Ex

Cum

Module DA.ASX.API.AssetServicing.CorporateActionOption_V001

Templates

template CorporateActionOption

FieldTypeDescription
operatorPartyThe operator
publicPartyPartyThe party for public disclosure
corporateActionEventIdCorporateActionEvent_V001.CorporateActionEventIdCorporate Action Event id
optionNumberTextOption Number
optionTypeOptionType_V001.OptionTypeOption Type
optionOfferOpenDateOptional DateOption Offer Open Date
optionOfferCloseDateOptional DateOption Offer Close Date
optionStatusOptional OptionStatus_V001.OptionStatusOption Status
  • Choice Archive

Module DA.ASX.API.AssetServicing.DividendElection_V001

Templates

template DividendElection

operatorPartyThe operator
controllerPartyOptional PartyThe account controller
issuerPartyOptional PartyThe issuer party
requestingActorIdActor.Actor_V001.KThe actor who requested the election (ASX: Requesting Actor Id)
transactionIdTextTransaction ID of the bid (ASX: Transaction Id)
corporateActionEventIdCorporateActionEvent_V001.CorporateActionEventIdCorporate Action Id (ASX: Corporate Action Event Id)
eventTypeCorporateActionEventType_V001.CorporateActionEventType
optionCodeTextCode UNSO (ASX: Option Code)
optionTypeOptionType_V001.OptionTypeOption selected by requester (ASX: Option Type)
accountIdAccount.Account_V001.KIdentifier of the account for the election (ASX: Account Id)
securityIdSecurity.SecurityId_V001.SecurityIdUnique identifier of the underlying security (ASX: Security Id)
instructedQuantityInstructedQuantity_V001.InstructedQuantity
instructedPercentageRateOptional (Numeric 10)
statusText
cancellationReasonOptional CancellationRequestReason_V001.CancellationRequestReason
  • Choice Archive

Module DA.ASX.API.AssetServicing.DividendElectionQuery_V001

Templates

template DividendElectionQuery

operatorPartyThe operator
controllerPartyOptional PartyThe account controller
issuerPartyOptional PartyThe issuer party
transactionIdTextUnique identifier for the Dividend Election Enquiry request (ASX: Transaction Id)
queryTypeCorporateActionEventType_V001.CorporateActionEventType
accountIdAccount.Account_V001.KUnique identifier of the Account (HIN) with securities entitled to the dividend election (ASX: Account Id)
securityIdSecurity.SecurityId_V001.SecurityIdUnique identifier of the underlying security (ASX: Security Id)
statusText
  • Choice Archive

Module DA.ASX.API.AssetServicing.InstructedQuantity_V001

Data Types

data InstructedQuantity

Quantity (Numeric 6)

AllSecurities

(ASX: QALL)

Module DA.ASX.API.AssetServicing.CancellationRequestReason_V001

Data Types

data CancellationRequestReason

IneligibleToParticipate

(ASX: PARX)

InvestorRequest

(ASX: IREQ)

LegalEntitlement

(ASX: LEGL)

PlanSuspendedOrInactive

(ASX: SUSP)

ZeroHolding

(ASX: NOHO)

Other

(ASX: OTHR)





Related Pages:

There are no related labels.

Browse Popular Pages:

No labels match these criteria.



This document provides general information only. ASX Limited (ABN 98 008 624 691) and its related bodies corporate (“ASX”) makes no representation or warranty with respect to the accuracy, reliability or completeness of the information. To the extent permitted by law, ASX and its employees, officers and contractors shall not be liable for any loss or damage arising in any way (including by way of negligence) from or in connection with any information provided or omitted or from anyone acting or refraining to act in reliance on this information.

© 2022 ASX Limited ABN 98 008 624 691