Ejemplos de uso
===============

.. _stock_prices_example:

Precios de cierre
-----------------

**Ejemplo de solicitud**

.. code-block:: python

   import pandas as pd
   import requests
   
   API_KEY = 'api_key'

   payload = {
      "key": API_KEY,
      'tickers': ['CMPC', 'COPEC'],
      'values': ['close'],
      'start': '2018-01-01',
   }

   r = requests.post('https://dolphin.markets/api/stocks', json=payload)
   df = pd.read_json(r.json())
   
   df.head()

Con esto obtenemos lo siguiente:

.. code-block:: none

          close	      date	ticker
   490	7480.0	2021-01-04	COPEC
   492	8064.0	2021-01-07	COPEC
   495	8090.0	2021-01-13	COPEC
   497	7911.0	2021-01-11	COPEC
   499	8000.0	2021-01-08	COPEC


.. _complex_dividend_amount:

Dividendos pagados para empresas IGPA
-------------------------------------

**Ejemplo de solicitud**

Puedes combinar solicitudes a nuestra API a fin de realizar cálculos más complejos. En el siguiente ejemplo te mostramos cómo calcular el total de dividendos pagados en los últimos trimestres para las empresas pertenecientes al IGPA. 

Para ello, primero obtenemos los dividendos pagados por cada empresa en el IGPA, luego obtenemos la cantidad de acciones para cada empresa en el IGPA y finalmente multiplicamos ambas tablas para obtener el total de dividendos pagados por cada empresa.

.. code-block:: python

   import requests
   import pandas as pd

   API_KEY = '527c576f-c941-4f32-b630-ed83cabe8ec9'

   igpa = [
      'AESANDES', 'AGUAS-A', 'ALMENDRAL', 'ANDINA-A',
      'ANDINA-B', 'ANTARCHILE', 'BANVIDA', 'BCI',
      'BESALCO', 'BLUMAR', 'BSANTANDER', 'CAMANCHACA',
      'CAP', 'CCU', 'CEMENTOS', 'CENCOSHOPP',
      'CENCOSUD', 'CHILE', 'CINTAC', 'CMPC',
      'COLBUN', 'COLO COLO', 'CONCHATORO', 'COPEC',
      'ECL', 'EISA', 'EMBONOR-B', 'ENELAM',
      'ENELCHILE', 'ENELGXCH', 'ENJOY', 'ENTEL',
      'FALABELLA', 'GASCO', 'HABITAT', 'HF',
      'HITES', 'IAM', 'ILC', 'INVERCAP',
      'ITAUCORP', 'LAS CONDES', 'LTM', 'MALLPLAZA',
      'MANQUEHUE', 'MASISA', 'MINERA', 'MOLLER',
      'MULTI X', 'NITRATOS', 'NORTEGRAN', 'NUEVAPOLAR',
      'ORO BLANCO', 'PARAUCO', 'PAZ', 'PEHUENCHE',
      'PUCOBRE', 'QUINENCO', 'RIPLEY', 'SALFACORP',
      'SALMOCAM', 'SECURITY', 'SK', 'SMSAAM',
      'SMU', 'SOCOVESA', 'SONDA', 'SOQUICOM',
      'SQM-A', 'SQM-B', 'TRICOT', 'VAPORES',
      'WATTS', 'ZOFRI',
   ]

   payload = {
      "key": API_KEY,
      'tickers': igpa,
   }
   r = requests.post('https://dolphin.markets/api/dividends', json=payload)

   df = pd.DataFrame(r.json())
   df['date'] = pd.to_datetime(df['date'])

   dividends = df.pivot_table(index='date', values='value', columns='ticker', aggfunc='sum')

   payload = {
      "key": API_KEY,
      'values': ['shares_outstanding_all_series', 'shares_outstanding'],
      'tickers': igpa,
   }

   r = requests.post('https://dolphin.markets/api/stocks', json=payload)
   shares = pd.DataFrame(r.json())
   shares['date'] = pd.to_datetime(shares['date'])
   shares = shares.pivot_table(index='date', values='shares_outstanding', columns='ticker')
   shares.loc[dividends.index[-1]] = shares.iloc[-1]
   shares = shares.asfreq('d').ffill()

   total_dividends_paid = dividends.mul(shares)