Bull Bear Score

The following endpoints retrieve the Bull Bear Score of a stock.

---

Bull Bear Score Ts

Returns the bull bear score timeseries of a stock

Examples

Curl

Note: If you are using Windows, adjust the syntax:

• Replace line breaks (\) with caret (^).
• Use double quotes (") instead of single quotes (').

curl -X 'GET' \
  'https://quant.api.yukkalab.com/trading/v3/company/apple/bull_bear_score_ts?date_from=2024-07-01&date_to=2024-07-05' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer $YUKKA_TOKEN" 

Python

import requests
import os

headers = {'Authorization': f'Bearer {os.environ["YUKKA_TOKEN"]}'}

params = {
    'date_from': '2024-07-01',
    'date_to': '2024-07-05',
}

response = requests.get(
    'https://quant.api.yukkalab.com/trading/v3/company/apple/bull_bear_score_ts',
    params=params,
    headers=headers,
).json()

Return type

BullBearScoreTsResponseV2

Example Response

{"exchange_code":"US","exchange_name":"USA Stocks","currency":"USD","ticker":"AAPL.US","score_ts":[{"date":"2024-07-01","score":9.537114143371582},{"date":"2024-07-02","score":9.041208267211914},{"date":"2024-07-03","score":9.446427345275879},{"date":"2024-07-04","score":9.342845916748047}],"score_ts_last_score":{"date":"2024-07-04","score":9.342845916748047},"entity_info":{"type":"company","alpha_id":"apple","compound_key":"company:apple"}}

Parameters

Name	Type	Description	Notes
entity_type	str
entity_id	str
time_horizon	str	Which time horizon for investment to consider. One of [1D, 1W, 1M, 3M]	[optional]
date_from	date	Date to start from when using time ranges	[optional]
date_to	date	Date to end from (exclusively) when using time ranges	[optional]
default_time_back	str	Default period of time that is used when no end date is supplied	[optional][default to 1w]

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

---

Bull Bear Score Ts Itemized

Returns the Stock price timeseries of a stock

Examples

Curl

Note: If you are using Windows, adjust the syntax:

• Replace line breaks (\) with caret (^).
• Use double quotes (") instead of single quotes (').

curl -X 'POST' \
  'https://quant.api.yukkalab.com/trading/v3/portfolio/bull_bear_score_ts_itemized?date_from=2024-07-01&date_to=2024-07-05' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $YUKKA_TOKEN" \
  -d '["company:apple", "company:sap"]'

Python

import requests

headers = {'Authorization': f'Bearer {os.environ["YUKKA_TOKEN"]}'}

params = {
    'date_from': '2024-07-01',
    'date_to': '2024-07-05',
}

json_data = [
    'company:apple',
    'company:sap',
]

response = requests.post(
    'https://quant.api.yukkalab.com/trading/v3/portfolio/bull_bear_score_ts_itemized',
    params=params,
    headers=headers,
    json=json_data,
).json()
print(response)

Return type

BullBearScoreTsItemizedResponseV2

Example Response

{"exchange_code":null,"exchange_name":null,"currency":null,"ticker":null,"score_ts_itemized":[{"exchange_code":"US","exchange_name":"USA Stocks","currency":"USD","ticker":"AAPL.US","score_ts":[{"date":"2024-07-01","score":9.537114143371582},{"date":"2024-07-02","score":9.041208267211914},{"date":"2024-07-03","score":9.446427345275879},{"date":"2024-07-04","score":9.342845916748047}],"score_ts_last_score":{"date":"2024-07-04","score":9.342845916748047},"entity_info":{"type":"company","alpha_id":"apple","compound_key":"company:apple"}},{"exchange_code":"XETRA","exchange_name":"XETRA Exchange","currency":"EUR","ticker":"SAP.XETRA","score_ts":[{"date":"2024-07-01","score":0.6467081904411316},{"date":"2024-07-02","score":0.8555973172187805},{"date":"2024-07-03","score":0.8889438509941101},{"date":"2024-07-04","score":2.6293318271636963}],"score_ts_last_score":{"date":"2024-07-04","score":2.6293318271636963},"entity_info":{"type":"company","alpha_id":"sap","compound_key":"company:sap"}}]}

Parameters

Name	Type	Description	Notes
request_body	List[str]
date_from	date	Date to start from when using time ranges	[optional]
date_to	date	Date to end from (exclusively) when using time ranges	[optional]
default_time_back	str	Default period of time that is used when no end date is supplied	[optional][default to 1w]

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

---

Bullish Stocks Overlay

Examples

Curl

Note: If you are using Windows, adjust the syntax:

• Replace line breaks (\) with caret (^).
• Use double quotes (") instead of single quotes (').

curl -X 'GET' \
  'https://quant.api.yukkalab.com/signal/bullish_stocks?date_from=2023-01-01&date_to=2023-01-05&time_horizon=3M' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer $YUKKA_TOKEN"   

Python

import requests

headers = {
    'accept': 'application/json',
    'Authorization': f'Bearer {token}',
}

params = {
    'date_from': '2023-01-01',
    'date_to': '2023-01-05',
    'time_horizon': '3M',
}

response = requests.get('https://quant.api.yukkalab.com/signal/bullish_stocks', params=params, headers=headers)

Return type

BullishStocksOverlay

Example Response

{"bullish_stocks":[{"exchange_code":"US","exchange_name":"USA Stocks","currency":"USD","ticker":"CUTR.US","entity_info":{"type":"company","alpha_id":"company:cutera_inc","compound_key":"company:company:cutera_inc"},"date":"2023-06-26","yukka_id":"company:cutera_inc","industry":"industry.health_care","bull_bear_score":1.0,"squid_score":0.578360445927494,"price":15.75,"price_delta":-0.3534482717514038,"name":"Cutera Inc","isin":"US2321091082","country_name":"United States of America","country_id":"us"}]}

Parameters

Name	Type	Description	Notes
amount	int		[optional][default to 15]
industry	str	Which industry to filter for. One of [all, energy, basic_materials, health_care, consumer_discretionary, industrials, consumer_goods, oil_gas, consumer_services, real_estate, consumer_staples, technology, telecommunications, financials, utilities]	[optional][default to all]
time_horizon	str	Which time horizon for investment to consider. One of [1D, 1W, 1M, 3M]	[optional]
source_country	str	Which country to filter for. One of [all, ar, at, au, bd, be, bm, br, ca, ch, cl, cn, co, cy, de, dk, es, fi, fr, gb, gg, gr, hk, id, ie, il, im, in, it, je, jp, kr, ky, lu, mx, nl, no, nz, pk, pl, pt, ru, sa, se, sg, th, tr, tw, us, vg, vn, za]	[optional][default to all]
stock_index	str	Which country to filter for. One of [all, STOXX 600, SP 500, DAX, Russell 3000, Russell 2000, Russell 1000, MSCI World]	[optional][default to all]

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

---

Bearish Stocks Overlay

Examples

Curl

Note: If you are using Windows, adjust the syntax:

• Replace line breaks (\) with caret (^).
• Use double quotes (") instead of single quotes (').

curl -X 'GET' \
  'https://quant.api.yukkalab.com/signal/bearish_stocks?date_from=2023-01-01&date_to=2023-01-05&time_horizon=3M' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer $YUKKA_TOKEN"   

Python

import requests

headers = {
    'accept': 'application/json',
    'Authorization': f'Bearer {token}',
}

params = {
    'date_from': '2023-01-01',
    'date_to': '2023-01-05',
    'time_horizon': '3M',
}

response = requests.get('https://quant.api.yukkalab.com/signal/bearish_stocks', params=params, headers=headers)

Return type

BearishStocksOverlay

Example Response

{"bearish_stocks":[{"exchange_code":"CO","exchange_name":"Copenhagen Exchange","currency":"DKK","ticker":"VWS.CO","entity_info":{"type":"company","alpha_id":"company:vestas_wind_systems","compound_key":"company:company:vestas_wind_systems"},"date":"2023-06-26","yukka_id":"company:vestas_wind_systems","industry":"industry.energy","bull_bear_score":-1.0,"squid_score":0.4968942130592031,"price":179.74000549316406,"price_delta":-0.05509406328201294,"name":"Vestas Wind Systems A/S","isin":"DK0061539921","country_name":"Denmark","country_id":"dk"}]}

Parameters

Name	Type	Description	Notes
amount	int		[optional][default to 15]
industry	str	Which industry to filter for. One of [all, energy, basic_materials, health_care, consumer_discretionary, industrials, consumer_goods, oil_gas, consumer_services, real_estate, consumer_staples, technology, telecommunications, financials, utilities]	[optional][default to all]
time_horizon	str	Which time horizon for investment to consider. One of [1D, 1W, 1M, 3M]	[optional]
source_country	str	Which country to filter for. One of [all, ar, at, au, bd, be, bm, br, ca, ch, cl, cn, co, cy, de, dk, es, fi, fr, gb, gg, gr, hk, id, ie, il, im, in, it, je, jp, kr, ky, lu, mx, nl, no, nz, pk, pl, pt, ru, sa, se, sg, th, tr, tw, us, vg, vn, za]	[optional][default to all]
stock_index	str	Which country to filter for. One of [all, STOXX 600, SP 500, DAX, Russell 3000, Russell 2000, Russell 1000, MSCI World]	[optional][default to all]

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-