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.Reference.BusinessDate_V001

Templates

FieldTypeDescription

operator	Party	The system operator
currentBusinessDate	Date	Current business date as per the C&S system business calendar (ASX: Current Business Date)
publicParty	Party	The party for public disclosure

• Choice Archive

Module DA.ASX.API.Reference.Calendar_V001

Templates

FieldTypeDescription

operator	Party	The system operator
calendar	[CalendarDay]	List of calendar dates
publicParty	Party	The party for public disclosure

• Choice Archive

Data Types

CalendarDay

FieldTypeDescription

date	Date	Date received in the calendar message
isBusinessDate	Bool	Specifies if a date is a valid Business Date (T) or a weekend/holiday (F)

Module DA.ASX.API.Security.Issuer_V001

Templates

FieldTypeDescription

operator	Party	The operator
issuerActorId	K	Issuer's Actor Id (ASX: Issuer Actor Id)
companyId	Text	Company Id, provided externally by ASX. (ASX: Company Id)
issuerFullName	Text	Issuer Full Name (ASX: Issuer Full Name)
issuerCode	Text	Issuer Code (ASX: Issuer Code)
publicParty	Party	The party for public disclosure

• Choice Archive

Data Types

Module DA.ASX.API.Security.Security_V001

Templates

FieldTypeDescription

operator	Party	The operator
publicParty	Party	The party for public disclosure
securityId	K	Unique Security Identifier, provided externally by ASX. (ASX: Security Id)
productId	ProductId_V001.ProductId	Unique Product Identifier, provided externally by ASX. (ASX: Product Id)
apirCode	Optional Text	The APIR code of the security (ASX: APIR Code)
securityCode	Optional Text	The market ticker for the security (ASX: Security Code)
isin	Optional Text	The ISIN bound to the security (ASX: ISIN)
derivedMic	Text
issuerActorId	Text	The UIC of the issuer actor for which the security is associated to. (ASX: Issuer Actor Id)
deferredDeliveryIndicator	Bool	Whether security is currently in a deferred delivery period (ASX: Deferred Delivery Indicator)
nettingEligible	Bool	Denotes whether the security can be netted within an NBO (ASX: Netting Eligible)
issuerSponsoredSubRegistry	Bool	Denotes whether the Issuer maintains a sub-register for the security (ASX: Issuer Sponsored Sub-Register)
firstListedDate	Optional Date	First Listed Date (ASX: First Listed Date)
lastListedDate	Optional Date	The date the security was de-listed, if relevant (ASX: Last Listed Date)
firstSettlementDate	Optional Date	First Settlement Date (ASX: First Settlement Date)
instrumentClassification	SecurityClassification_V001.SecurityClassification	The classification of the security for clearance and settlement (ASX: Instrument Classification)
securitySubRegisterState	SecuritySubRegisterState_V001.SecuritySubRegisterState	Security Sub-Register State (ASX: Security Sub-Register State)
settlementCategory	SettlementCategory_V001.SettlementCategory	Settlement Category (ASX: Settlement Category)
unitPrecision	Int	Unit Precision (ASX: Unit Precision)
lastActiveDate	Optional Date	The 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)
despatchDate	Optional Date	The 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)
fundStatusCode	Optional Text

• Choice Archive

Data Types

Module DA.ASX.API.AssetServicing.CorporateActionEventStage_V001

Data Types

Conditional

COND

Halt

HALT

Lapsed

LAPS

Unconditional

UCON

Withdrawn

WITH

Closed

CLOS

Module DA.ASX.API.AssetServicing.CorporateActionEventType_V001

Data Types

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

Module DA.ASX.API.AssetServicing.CorporateActionCancellationReason_V001

Data Types

ProcessingError

(ASX: PROC)

Withdrawn

(ASX: WITH)

Module DA.ASX.API.AssetServicing.BuybackType_V001

Data Types

EqualAccess

EQAC

OnMarket

ONMK

Module DA.ASX.API.AssetServicing.OfferType_V001

Data Types

OffMarket

OFFM

Proportional

PRPL

TakeoverOnMarket

ONMK

Module DA.ASX.API.AssetServicing.OptionStatus_V001

Data Types

Option status of corporate action bidding option

Cancelled

(ASX: CANC)

Inactive

(ASX: INTV)

Module DA.ASX.API.AssetServicing.OptionType_V001

Data Types

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

Active

Completed

Cancelled

Module DA.ASX.API.AssetServicing.CorporateActionSubType_V001

Data Types

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

Ex

Cum

Module DA.ASX.API.AssetServicing.CorporateActionOption_V001

Templates

FieldTypeDescription

operator	Party	The operator
publicParty	Party	The party for public disclosure
corporateActionEventId	CorporateActionEvent_V001.CorporateActionEventId	Corporate Action Event id
optionNumber	Text	Option Number
optionType	OptionType_V001.OptionType	Option Type
optionOfferOpenDate	Optional Date	Option Offer Open Date
optionOfferCloseDate	Optional Date	Option Offer Close Date
optionStatus	Optional OptionStatus_V001.OptionStatus	Option Status

• Choice Archive

Module DA.ASX.API.AssetServicing.DividendElection_V001

Templates

operator	Party	The operator
controllerParty	Optional Party	The account controller
issuerParty	Optional Party	The issuer party
requestingActorId	Actor.Actor_V001.K	The actor who requested the election (ASX: Requesting Actor Id)
transactionId	Text	Transaction ID of the bid (ASX: Transaction Id)
corporateActionEventId	CorporateActionEvent_V001.CorporateActionEventId	Corporate Action Id (ASX: Corporate Action Event Id)
eventType	CorporateActionEventType_V001.CorporateActionEventType
optionCode	Text	Code UNSO (ASX: Option Code)
optionType	OptionType_V001.OptionType	Option selected by requester (ASX: Option Type)
accountId	Account.Account_V001.K	Identifier of the account for the election (ASX: Account Id)
securityId	Security.SecurityId_V001.SecurityId	Unique identifier of the underlying security (ASX: Security Id)
instructedQuantity	InstructedQuantity_V001.InstructedQuantity
instructedPercentageRate	Optional (Numeric 10)
status	Text
cancellationReason	Optional CancellationRequestReason_V001.CancellationRequestReason

• Choice Archive

Module DA.ASX.API.AssetServicing.DividendElectionQuery_V001

Templates

operator	Party	The operator
controllerParty	Optional Party	The account controller
issuerParty	Optional Party	The issuer party
transactionId	Text	Unique identifier for the Dividend Election Enquiry request (ASX: Transaction Id)
queryType	CorporateActionEventType_V001.CorporateActionEventType
accountId	Account.Account_V001.K	Unique identifier of the Account (HIN) with securities entitled to the dividend election (ASX: Account Id)
securityId	Security.SecurityId_V001.SecurityId	Unique identifier of the underlying security (ASX: Security Id)
status	Text

• Choice Archive

Module DA.ASX.API.AssetServicing.InstructedQuantity_V001

Data Types

Quantity (Numeric 6)

AllSecurities

(ASX: QALL)

Module DA.ASX.API.AssetServicing.CancellationRequestReason_V001

Data Types

IneligibleToParticipate

(ASX: PARX)

InvestorRequest

(ASX: IREQ)

LegalEntitlement

(ASX: LEGL)

PlanSuspendedOrInactive

(ASX: SUSP)

ZeroHolding

(ASX: NOHO)

Other

(ASX: OTHR)