API for Financial Information
This document describes the channels offered by our API (version 6) to consult the financial information offered by our database.
CONFIDENTIALITY
This document, as well as any future version or amendments, is intended to guide strictly authorized users of EDI Financial who have been issued login credentials.
The information contained is strictly confidential and for the exclusive reading of the person(s) mentioned above, reproduction of any kind is prohibited, as well as any partial or total distribution without explicit consent.
CONNECTIONS
We have a primary site and a secondary site (backup) that you can connect to and consume the information, it is important to note that both sites are supported using the HTTP protocol or secure HTTPS protocol, these are:
• Primary site: http://financiero.edimex.com.mx/ws/v6
• Secured primary site: https://financiero.edimex.com.mx/ws/v6
• Secondary site: http://fro.edimex.com.mx/ws/v6
• Secured secondary site: https://fro.edimex.com.mx/ws/v6
API Methods
The API is organized into folders and each folder contains several methods (this is how we properly identify requests). All methods are designed and optimized to obtain very specific information about the data you are looking for, and to that end the methods accept different parameters that are used to apply filters to select the data that you are interested in.
All calls/requests must be of the type POST and will result in a generic JSON object with the following properties:
Below in the documentation, we describe the methods contained in each folder, as well as the parameters it supports for filtering the information and a summary of the results it returns.
AUTHORIZATION
Our API is Full-REST, so all calls are made with a request. To use our API, you need to have an access token, this token is assigned when creating an account in our system and must be sent in each request made to our endpoints. Without this token, you will not be able to access the data contained in our API. To obtain a token, please contact ventas@economatica.com.mx
The API Key should be included in the header of each request using the key "Authorization" with the value of the token provided by your account executive at EDI Financial.
Quotes
Methods for obtaining information on the quotation of any of the instruments registered in our database (stocks; funds; products; currencies; indexes; rates; etc.). It is also possible to obtain technical and trading indicators.
AUTHORIZATIONAPI Key
This folder is using API Key from collectionEDI-Financial-Api
POST
Current
https://financiero.edimex.com.mx/ws/v6/Quotes/Current
Gets the current price of the instrument(s) you are looking for. You can use this information to know the current quotation (with 120 minutes of delay) "Quote" as well as various indicators of each instrument. The "Date" field provides the date (in YYYYMMDD format) of the quotation and the fields with the prefix "Last" offers the values of the last closing.
It is important to consider that the instruments of the Mexican market (BMV) and the foreign market quoted in Mexico (SIC of the BMV), have a winter schedule of 8:30 am for opening and 3:30 pm for closing, in summer these schedules are moved one hour earlier.
Half an hour before the opening, the database is reset, so all fields of the day will contain the value "null" and will be filled until the instrument begins operations. You can use the fields with the prefix "Last" which correspond to the last closing during this period of time. At the close of the market, both the fields of the day and the fields with the prefix "Last" will contain the same information.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
Ticker
AMXL
Identifier of the instrument you want, you can repeat it to form an array. It is mandatory to indicate at least one "Ticker" or the "Tickers" parameter.
Ticker
IPYC
Identifier of the instrument you want, you can repeat it to form an array. It is mandatory to indicate at least one "Ticker" or the "Tickers" parameter.
Tickers
KIMBERA;VOLARA
list separated by; (semi-colon) of the identifiers of each instrument you want. The limit is 20 instruments per query. It is mandatory to indicate at least one "Ticker" or the "Tickers" parameter.
POST
Intraday
https://financiero.edimex.com.mx/ws/v6/Quotes/Intraday
Obtains a sample of the quotations (facts) of the instrument you are looking for intraday. You can use this information to generate a chart of the price behavior on the last day of operation, the "Tick" field is the timestamp and the "Quote" field is the price. Remember that on all business days, this information is reset to allow for the operation of the new day.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
Ticker
AMXL
Identifier of the instrument you want. Required, only one is allowed.
Sample
9
Sample of how many points are required for your chart. Required between 1 and 10000.
POST
Historical
https://financiero.edimex.com.mx/ws/v6/Quotes/Historical
Obtains the historical prices of the instrument you are looking for within the specified time range. You can use this information to generate a historical chart (day by day) of the price behavior of the instrument. The "Date" field corresponds to the date in YYYYMMDD format and the "Quote" field corresponds to the price.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
Ticker
AMXL
Identifier of the instrument you want. Required, only one is allowed.
From
20221201
Initial date in YYYYMMDD format. Required.
To
20221202
Final date in YYYYMMDD format. Required.
Financial Statements
Methods for obtaining financial information, commonly known as quarterly financial reports, of the companies registered in our database. For Mexican companies, the source of information is BMV and CNBV. For companies in the USA, the source of information is EDGAR. In both cases, the information may be offered with a delay of up to 12 hours from the time it is published and is available in our database.
AUTHORIZATIONAPI Key
This folder is using API Key from collectionEDI-Financial-Api
POST
Status
https://financiero.edimex.com.mx/ws/v6/FinancialStatements/Status
Obtains the status of the availability of financial reports in the database, for an issuer in one year and period, or all the reports of a financial model in one year and period. You can use this information during the quarterly reporting period to know which ones are already available in the database for consumption and which ones are not yet available.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
idModel
Ind2 Mexico
Identifier of financial model, one of the following: GrpFin Mx; Ind2 Mexico; Insur Mex; US Banks; US Ind II; US Indust; US Insur; US Real Estate; US Utilty. Not required if CIK or Ticker is provided.
CIK
0000320193
Numeric identifier assigned by EDGAR to companies in the North American market. Not required if idModel or Ticker is provided.
Ticker
AMXL
Identifier of the instrument you want. Not required if idModel or CIK is provided.
Year
2022
Year of the financial report(s) you are looking for. Required.
Period
3
Period of the financial report(s) you are looking for. In the case of quarterly reports: 1= jan-feb-mar; 2=apr-may-jun; 3=jul-aug-sep; 4=oct-nov-dec. Required.
POST
Taxonomy
https://financiero.edimex.com.mx/ws/v6/FinancialStatements/Taxonomy
DESCRIPTION:
Obtains a list of the taxonomy (accounts and indicators) that make up a financial report (monthly, quarterly, or annual) organized by:
The taxonomy of these financial reports differs between industrial and commercial companies, banks and insurance companies, etc, which we identify as the financial model. The taxonomy includes properties such as ConditionSequence and ElementSequence that allow for the correct ordering of the financial report. You can use this information to determine the entirety of a financial model for a specific company.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
idModel
Ind2 Mexico
Identifier of financial model, one of the following: GrpFin Mx; Ind2 Mexico; Insur Mex; US Banks; US Ind II; US Indust; US Insur; US Real Estate; US Utilty. Required.
idStatement
http://bmv.com.mx/role/ifrs/ias_1_2014-03-05_role-210000
Identifier of the financial statement, but it depends on the financial model as not all statements are assigned to all models. Optional.
idContext
INST
Context of the value of each financial element (account), one of the following for financial reports in Spanish: INST; ACUM; TWELVE O'CLOCK; TRIM; NFP; PINI; NA. For financial reports in English: FY; Q; 12M. Optional.
idElement
ifrs-full:Assets
Financial element identifier (better known as account). Optional.
POST
TaxonomyAndInstanceData
https://financiero.edimex.com.mx/ws/v6/FinancialStatements/TaxonomyAndInstanceData
DESCRIPTION:
Obtains a "header" record with the general data of the report and a list of "details" with the taxonomy (accounts and indicators) that confirm a financial report (monthly, quarterly or annual), but combining the data of a report for a company, year and period (we call this "instance"), organized by:
It is important to keep in mind that the objective of this method is to provide the taxonomy first and the data second, so if you call a report that does not exist in our database, all the accounts will appear with a "null" value. If you call up a report that does exist in our database, only the unreported accounts will have a "null" value.
Although you can filter the accounts with the parameters that you indicate (model, state, context, element, etc.), only one value will always be displayed for an account and it will correspond to the year and period indicated in the parameters as well.
You can use this information to build a comparative table of reports from the same company, but in different periods (taking taxonomy changes into account) or even compare reports from different companies, but with the same taxonomies.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
CIK
0000320193
Numeric identifier assigned by EDGAR to companies in the North American market. It is not required if the Ticker is provided.
Ticker
AMXL
Identifier of the instrument you want. Not required if CIK is provided.
Year
2022
Year of the financial report(s) you are looking for. Mandatory.
Period
3
Financial reporting period(s) you are seeking. In the case of quarterly reports: 1= Jan-Feb-Mar; 2=apr-may-jun; 3=Jul-Aug-Sep; 4=Oct-Nov-Dec. Mandatory.
idModel
Ind2 Mexico
Financial model identifier, one of the following: annex; GrpFin Max; Ind2 Mexico; Insur Mex; US Banks; US Ind II; US Industry; US Insur; US Real Estate; US Utility. Optional.
idStatement
http://bmv.com.mx/role/ifrs/ias_1_2014-03-05_role-210000
Financial statement identifier, but depends on the financial model as not all statements map to all models. Optional.
idContext
INST
Context of the value of each financial element (account), one of the following for financial reports in Spanish: INST; ACUM; DOCE; TRIM; PFIN; PINI; NA. Para reportes financieros en inglés: FY; Q; 12M. Opcional.
idElement
ifrs-full:Assets
Financial element identifier (better known as account). Optional.
POST
InstanceData
https://financiero.edimex.com.mx/ws/v6/FinancialStatements/InstanceData
Gets a list of the values of accounts and indicators that confirm a financial report (monthly, quarterly, or yearly) for a company, year, and period (referred to as an "instance").
Unlike methods that start with the "Taxonomy" prefix, the goal of this method is to provide only the values of the accounts, so that if an account was not reported in a particular instance, it will not be included in the response.
This method allows you to filter the accounts with the parameters you indicate (model, state, context, element, etc.), but you can also indicate "zero" in the year and/or period, to obtain the values of an account for all periods available in the database.
You can use this information to generate a graph with the evolution of an account or financial indicator over time.
This method does not provide the full taxonomy, only the account keys and values.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
CIK
0000320193
Numeric identifier assigned by EDGAR to companies in the North American market. It is not required if the Ticker is provided.
Ticker
AMXL
Identifier of the instrument you want. Not required if CIK is provided.
Year
2022
Year of the financial report(s) you are looking for. Mandatory.
Period
3
Financial reporting period(s) you are seeking. In the case of quarterly reports: 1= Jan-Feb-Mar; 2=apr-may-jun; 3=Jul-Aug-Sep; 4=Oct-Nov-Dec. Mandatory.
idModel
Ind2 Mexico
Financial model identifier, one of the following: annex; GrpFin Max; Ind2 Mexico; Insur Mex; US Banks; US Ind II; US Industry; US Insur; US Real Estate; US Utility. Optional.
idStatement
http://bmv.com.mx/role/ifrs/ias_1_2014-03-05_role-210000
Financial statement identifier, but depends on the financial model as not all statements map to all models. Optional.
idContext
INST
Context of the value of each financial element (account), one of the following for financial reports in Spanish: INST; ACUM; TWELVE O'CLOCK; TRIM; NFP; PINI; NA. For financial reports in English: FY; Q; 12M. Optional.
idElement
ifrs-full:Assets
Financial element identifier (better known as account). Optional.
POST
InstanceDataAndTaxonomy
https://financiero.edimex.com.mx/ws/v6/FinancialStatements/InstanceDataAndTaxonomy
Gets a list of the values of accounts and indicators that confirm a financial report (monthly, quarterly, or yearly) for a company, year, and period (referred to as an "instance").
Unlike methods that start with the "Taxonomy" prefix, the goal of this method is to provide the values of the accounts, so that if an account was not reported in a particular instance, it will not be included in the response.
This method allows you to filter the accounts with the parameters you indicate (model, state, context, element, etc.), but you can also indicate "zero" in the year and/or period, to obtain the values of an account for all periods available in the database.
You can use this information to generate a graph with the evolution of an account or financial indicator over time.
Unlike InstanceData, this method does provide the full taxonomy.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
CIK
0000320193
Numeric identifier assigned by EDGAR to companies in the North American market. It is not required if the Ticker is provided.
Ticker
AMXL
Identifier of the instrument you want. Not required if CIK is provided.
Year
2022
Year of the financial report(s) you are looking for. Mandatory.
Period
3
Financial reporting period(s) you are seeking. In the case of quarterly reports: 1= Jan-Feb-Mar; 2=apr-may-jun; 3=Jul-Aug-Sep; 4=Oct-Nov-Dec. Mandatory.
idModel
Ind2 Mexico
Financial model identifier, one of the following: annex; GrpFin Max; Ind2 Mexico; Insur Mex; US Banks; US Ind II; US Industry; US Insur; US Real Estate; US Utility. Optional.
idStatement
http://bmv.com.mx/role/ifrs/ias_1_2014-03-05_role-210000
Financial statement identifier, but depends on the financial model as not all statements map to all models. Optional.
idContext
INST
Context of the value of each financial element (account), one of the following for financial reports in Spanish: INST; ACUM; TWELVE O'CLOCK; TRIM; NFP; PINI; NA. For financial reports in English: FY; Q; 12M.Optional.
idElement
ifrs-full:Assets
Financial element identifier (better known as account). Optional.
System
Methods to obtain information on the system version, as well as information from the user himself.
AUTHORIZATIONAPI Key
This folder is using API Key from collectionEDI-Financial-Api
POST
About
https://financiero.edimex.com.mx/ws/v6/System/About
DESCRIPTION:
Gets system information, commonly called “About System”. This information offers you the versions of the different system components, the most important being the "API" version.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
BODY
POST
AccountInfo
https://financiero.edimex.com.mx/ws/v6/System/AccountInfo
DESCRIPTION:
Obtains information from the user, commonly referred to as “About the user”. This information offers you the registration data, as well as the role / profile and rights of your user.
AUTHORIZATIONAPI Key
This request is using API Key from collectionEDI-Financial-Api
