News Item
New Item
This is the main model that MFN delivers through its APIs. Our objective to be very clear about the following
How to identify the news item (
news_id)How to identify versions of the news item (
group_id)Who is the author (
author)Who is being referenced in the press release (
subjects)What it is regarding (
properties)
Model
{
// A id that uniquely identifies this new item
"news_id": UUID string,
// A id that uniquely identifies a set of news item with different languages
"group_id": UUID string,
// A url that links to a public page where the item can be viewed
"url": URL string,
// A object describing who is the author of the news item
"author": Entity,
// A array of objects describing who the news item relates to
// This field discribe how is subject in the press release,
// NOT the subject of the item
"subjects": [Entity],
// A object containing properties relating to the news item
"properties": Properties,
// A object containing the content of the news item
"content": NewsContent,
// Should always be mfn and describes the source of the press release
"source": string,
// A object where new types of metadata might be added at futer date
"extensions": Extension
}Entity
The entity describes a entity that in some way is referenceable. This includes, but not limited to companies. It can also be other types of entities such as funds. Entities is used for referencing both the author and the subjects of the news item. This serve to define Who says something and about Whom. In most cases Author entity and Subjects entity will be the same in the case of regular press releases.
Important to note regarding Entities is that the number of fields might grow to allow for more precise identification of the entity, therefor it is important to to for your model allow for this. In statically typed languages such as Java or C# it is a good idea to have a “AnySetter” for your model, that consumes all other parameters that you have not specified.
Model
NewsContent
The news content contains the content of the news item as well as attachments, such as pdfs.
Model
Attachment
Attachments allow for files of different types to be attached to a News Item. This can include pdf, images or just links
Model
Properties
The properties object contain metadata about the news item that describes it. One of the more important aspects of this object is the type property which relates for whom the news item is targeted. If it is set to IR, Investor Relation, this means that the target is investors and the stock market. While PR, Public Relation, is meant for news desks and should have no real bearing on the stock market. By default all APIs only relay IR types
Model
Tags
Tags is an array of strings, each string defines one tag. A tag can be viewed as a boolean property being true if present. A tag is divided into at least two parts, a namespace and the content, e.g. sub:report:interim where sub is the namespace. Tag can be added to the different namespaces over time, but they should always appear in this documentation
Tags describe in general the taxonomy and classification of press releases. This is done primary through the root and sub namespace listed below. The tags are hierarchical by nature and the entire hierarchy should be present, mening that id sub:report:interim:q4 appears in a tag, sub:report:interim and sub:report also appears
Namespaces
There are a few namespaces and tags that follow with each.
Root namespace
This namespace is important in some contexts and will always be the first thing in the array. It is defined by metadata that must be present.
Tags
:regulatoryindicates that news item is required by some regulation:regulatory:marindicates that news item is required by EU Market Abuse Regulation:regulatory:vpmlindicates that news item is required by Swedish "Lagen om värdepappersmarknaden" Regulation:regulatory:lhfiindicates that news item is required by Swedish "Lagen om handel med finansiella instrument" Regulation:regulatory:listingindicates that news item is Stock Exchange Listing Requirement:correctionA correction of a previous sent news item:correction:{news_id}A correction with a reference to the news id of which it corrects
Subject namespace, prefix sub:
This namespace contain metadata that helps to categorize the news item. This namespace is defined by MFN and addition.
sub:reportindicates that news is report of some kindsub:report:annualindicates that news is a Annual reportsub:report:interimindicates that news is a Interim reportsub:report:interim:q1indicates that news is a First Quarter Interim reportsub:report:interim:q2indicates that news is a Second Quarter Interim report, a.k.a. Semi Annualsub:report:interim:q3indicates that news is a Third Quarter Interim reportsub:report:interim:q4indicates that news is a Forth Quarter Interim report, a.k.a. Year Endsub:caindicates that news item is related to a Corporate Actionsub:ca:sharesindicates that news item is related a change in number of shares or votessub:ca:shares:issuanceindicates that news item informs about stock issuancesub:ca:shares:repurchaseindicates that news item informs repurchase of stockssub:ca:shares:rightsindicates that news item informs about changes to stock rights or classessub:ca:maindicates that news item is related to Mergers & Acquisitionssub:ca:ipoindicates that news item is related to a iposub:ca:prospectusindicates that news item is related to a prospectussub:ca:otherindicates that news item is related to other Corporate Actionsub:ciindicates that news item is related to Corporate Informationsub:ci:gmindicates that news item is related to a general meetingsub:ci:gm:noticeindicates that news item is a Notice to a General Meetingsub:ci:gm:infoindicates that news item is a Report from a General Meetingsub:ci:insiderindicates that news item is a insider transactionsub:ci:shareholder-announcementindicates that news item is a shareholder announcementsub:ci:calendarindicates that news item is a financial calendarsub:ci:presentationindicates that news item is related to a presentationsub:ci:nominationindicates that news item is related to Nomination Committeesub:ci:earningsindicates that news item informs about a earnings reportsub:ci:salesindicates that news item informs about some salessub:ci:sales:orderindicates that news item informs about a incoming sales ordersub:ci:staffindicates that news item is related to staff changessub:ci:staff:xxoindicates that news item is related to executive staff changessub:ci:otherindicates that news item is related to other Corporate Information
Custom namespace, prefix cus:
Author of a news item can add their own tags in order to categorize their content, but should in most cases probably be ignored by third parties. example might be cus:fintech
JSON Example
Last updated
Was this helpful?