Skip to content
Security Scores

Get security score and investment style

Returns the security's overall score and rating, scores for each dimension and detail indicator, its position and description in the 3×3 investment style box, and its industry rank with industry mean and median scores. Use it for the Investment Style block on the Overview tab and the score analysis page. Show an empty state when invest_style_grid is 0 or the style or size text is empty.

GEThttps://api.lbkrs.com/v2/stock-info/security-ratings

Parameters

counter_idstringqueryRequired

Security ID, such as ST/US/AAPL

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get security score and investment style” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Security score

multi_scorestring

Overall score

multi_letterstring

Overall rating letter, A to E

Values
A
B
C
D
E
multi_score_change_v2integer

Change direction versus the previous period:

  • 2 - Up sharply
  • 1 - Up
  • 0 - Unchanged
  • -1 - Down
  • -2 - Down sharply
Values
2
1
0
-1
-2
ratingsarray<object>

Score groups: style, size, and multi-factor score

Child attributes
typeinteger

Group type:

  • 1 - Investment style
  • 2 - Size
  • 3 - Multi-factor score
Values
1
2
3
indicatorobject

Score indicator

Child attributes
field_namestring

Indicator field name. Pass it as rating_indicator to GET /fa/rating-indicators-history

namestring

Indicator name in the request language

valuestring

Indicator value

value_typestring

Value format:

  • percent - Percent value; append % when displaying
  • bignumber - Large number; abbreviate when displaying

Display other values as is

value_colorboolean

When true, show value in up/down colors and prefix positive values with +

scorestring

Indicator score

letterstring

Rating letter from A to E; A is the best

Values
A
B
C
D
E
change_v2integer

Change direction versus the previous period:

  • 2 - Up sharply
  • 1 - Up
  • 0 - Unchanged
  • -1 - Down
  • -2 - Down sharply
Values
2
1
0
-1
-2
sub_indicatorsarray<object>

Sub-dimensions

Child attributes
indicatorobject

Score indicator

Child attributes
field_namestring

Indicator field name. Pass it as rating_indicator to GET /fa/rating-indicators-history

namestring

Indicator name in the request language

valuestring

Indicator value

value_typestring

Value format:

  • percent - Percent value; append % when displaying
  • bignumber - Large number; abbreviate when displaying

Display other values as is

value_colorboolean

When true, show value in up/down colors and prefix positive values with +

scorestring

Indicator score

letterstring

Rating letter from A to E; A is the best

Values
A
B
C
D
E
change_v2integer

Change direction versus the previous period:

  • 2 - Up sharply
  • 1 - Up
  • 0 - Unchanged
  • -1 - Down
  • -2 - Down sharply
Values
2
1
0
-1
-2
sub_indicatorsarray<object>

Detail indicators

Child attributes
field_namestring

Indicator field name. Pass it as rating_indicator to GET /fa/rating-indicators-history

namestring

Indicator name in the request language

valuestring

Indicator value

value_typestring

Value format:

  • percent - Percent value; append % when displaying
  • bignumber - Large number; abbreviate when displaying

Display other values as is

value_colorboolean

When true, show value in up/down colors and prefix positive values with +

scorestring

Indicator score

letterstring

Rating letter from A to E; A is the best

Values
A
B
C
D
E
change_v2integer

Change direction versus the previous period:

  • 2 - Up sharply
  • 1 - Up
  • 0 - Unchanged
  • -1 - Down
  • -2 - Down sharply
Values
2
1
0
-1
-2
invest_style_gridinteger

Position in the 3×3 style box, 1 to 9; 0 means no data. Row = (invest_style_grid - 1) / 3 (0 large-cap, 1 mid-cap, 2 small-cap); column = (invest_style_grid - 1) % 3 (0 value, 1 blend, 2 growth)

scale_descriptionstring

Size description, such as “Large-cap”

invest_style_descriptionstring

Style description, such as “Growth”. Join it with scale_description for the block title

style_txt_namestring

Style metric name

style_txt_valuestring

Style metric value text

scale_txt_namestring

Size metric name

scale_txt_valuestring

Size metric value text

industry_idstring

Industry ID

industry_namestring

Industry name

industry_rankstring

Overall score rank within the industry

industry_totalstring

Number of ranked securities in the industry

industry_mean_scorestring

Industry mean score

industry_mean_letterstring

Industry mean rating letter

Values
A
B
C
D
E
industry_median_scorestring

Industry median score

industry_median_letterstring

Industry median rating letter

Values
A
B
C
D
E
update_timeinteger

Score update time as a Unix timestamp in seconds

Whale Docs