yfrake.openapi.modules.earnings

Complexity

Total Complexity

0

Size/Duplication

Total Lines	222
Duplicated Lines	0 %

Importance

Changes

0

# ================================================================================== #
#   earnings.py - This file is part of the yfrake package.                           #
# ================================================================================== #
#                                                                                    #
#   MIT License                                                                      #
#                                                                                    #
#   Copyright (c) 2022 Mattias Aabmets                                               #
#                                                                                    #
#   Permission is hereby granted, free of charge, to any person obtaining a copy     #
#   of this software and associated documentation files (the "Software"), to deal    #
#   in the Software without restriction, including without limitation the rights     #
#   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell        #
#   copies of the Software, and to permit persons to whom the Software is            #
#   furnished to do so, subject to the following conditions:                         #
#                                                                                    #
#   The above copyright notice and this permission notice shall be included in all   #
#   copies or substantial portions of the Software.                                  #
#                                                                                    #
#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR       #
#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,         #
#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE      #
#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER           #
#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,    #
#   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE    #
#   SOFTWARE.                                                                        #
#                                                                                    #
# ================================================================================== #
summary = 'Earnings'
description = 'Returns the earnings of a security identifier.'

# ---------------------------------------------------------------------------------- #
parameters = [
    {
        'name': 'symbol',
        'description': 'Any valid equity security identifier.',
        'required': True,
        'in': 'query',
        'schema': {
            'type': str
        }
    }
]

# ---------------------------------------------------------------------------------- #
response = {
    'maxAge': int,
    'earningsChart': {
        'quarterly': [
            {
                'date': str,
                'actual': {
                    'raw': float,
                    'fmt': str
                },
                'estimate': {
                    'raw': float,
                    'fmt': str
                }
            },
            {
                'date': str,
                'actual': {
                    'raw': float,
                    'fmt': str
                },
                'estimate': {
                    'raw': float,
                    'fmt': str
                }
            },
            {
                'date': str,
                'actual': {
                    'raw': float,
                    'fmt': str
                },
                'estimate': {
                    'raw': float,
                    'fmt': str
                }
            },
            {
                'date': str,
                'actual': {
                    'raw': float,
                    'fmt': str
                },
                'estimate': {
                    'raw': float,
                    'fmt': str
                }
            }
        ],
        'currentQuarterEstimate': {
            'raw': float,
            'fmt': str
        },
        'currentQuarterEstimateDate': str,
        'currentQuarterEstimateYear': int,
        'earningsDate': [
            {
                'raw': int,
                'fmt': str
            },
            {
                'raw': int,
                'fmt': str
            }
        ]
    },
    'financialsChart': {
        'yearly': [
            {
                'date': int,
                'revenue': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                },
                'earnings': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                }
            },
            {
                'date': int,
                'revenue': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                },
                'earnings': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                }
            },
            {
                'date': int,
                'revenue': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                },
                'earnings': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                }
            },
            {
                'date': int,
                'revenue': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                },
                'earnings': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                }
            }
        ],
        'quarterly': [
            {
                'date': str,
                'revenue': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                },
                'earnings': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                }
            },
            {
                'date': str,
                'revenue': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                },
                'earnings': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                }
            },
            {
                'date': str,
                'revenue': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                },
                'earnings': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                }
            },
            {
                'date': str,
                'revenue': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                },
                'earnings': {
                    'raw': int,
                    'fmt': str,
                    'longFmt': str
                }
            }
        ]
    },
    'financialCurrency': str
}