yfrake.openapi.modules.esg_scores

Complexity

Total Complexity

0

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Importance

Changes

0

# ================================================================================== #
#   esg_scores.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 = 'ESG Scores'
description = 'Returns current ESG scores of a security identifier and its peer group.'

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

# ---------------------------------------------------------------------------------- #
response = {
    'maxAge': int,
    'totalEsg': {
        'raw': float,
        'fmt': str
    },
    'environmentScore': {
        'raw': float,
        'fmt': str
    },
    'socialScore': {
        'raw': float,
        'fmt': str
    },
    'governanceScore': {
        'raw': float,
        'fmt': str
    },
    'ratingYear': int,
    'ratingMonth': int,
    'highestControversy': float,
    'peerCount': int,
    'esgPerformance': str,
    'peerGroup': str,
    'relatedControversy': list,
    'peerEsgScorePerformance': {
        'min': float,
        'avg': float,
        'max': float
    },
    'peerGovernancePerformance': {
        'min': float,
        'avg': float,
        'max': float
    },
    'peerSocialPerformance': {
        'min': float,
        'avg': float,
        'max': float
    },
    'peerEnvironmentPerformance': {
        'min': float,
        'avg': float,
        'max': float
    },
    'peerHighestControversyPerformance': {
        'min': float,
        'avg': float,
        'max': float
    },
    'percentile': {
        'raw': float,
        'fmt': str
    },
    'environmentPercentile': float,
    'socialPercentile': float,
    'governancePercentile': float,
    'adult': bool,
    'alcoholic': bool,
    'animalTesting': bool,
    'catholic': bool,
    'controversialWeapons': bool,
    'smallArms': bool,
    'furLeather': bool,
    'gambling': bool,
    'gmo': bool,
    'militaryContract': bool,
    'nuclear': bool,
    'pesticides': bool,
    'palmOil': bool,
    'coal': bool,
    'tobacco': bool
}