Skip to main content

CFB — On3 Recruit Database (api.on3.com) — Organizations

on3_organizations_draft_class_by_state​

GET /rdb/v1/organizations/{organizationKey}/draft-class-by-state

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/draft-class-by-state

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/draft-class-by-state

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.
pagepageYpage query parameter.
pageSizepage_sizeYpageSize query parameter.

Returns​

return_parsed=True (default) — the output of parse_on3_rdb; pass return_as_pandas=True for a pandas.DataFrame.

No returns table is published for this endpoint: no committed capture with rows, and the response type is only heuristically mapped (x-source: call-site); names derived from the OpenAPI response type matched parse_on3_rdb's output on only 7 of the 9 checkable endpoints, so none are published.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_draft_class_by_state(organization_key=1867)

Last validated n/a.

on3_organizations_draft_class_by_year​

GET /rdb/v1/organizations/{organizationKey}/draft-class-by-year

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/draft-class-by-year

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/draft-class-by-year

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.
pagepageYpage query parameter.
pageSizepage_sizeYpageSize query parameter.

Returns​

return_parsed=True (default) — the output of parse_on3_rdb; pass return_as_pandas=True for a pandas.DataFrame.

No returns table is published for this endpoint: no committed capture with rows, and the response type is only heuristically mapped (x-source: call-site); names derived from the OpenAPI response type matched parse_on3_rdb's output on only 7 of the 9 checkable endpoints, so none are published.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_draft_class_by_year(organization_key=1867)

Last validated n/a.

on3_organizations_draft_count_by_stars​

GET /rdb/v1/organizations/{organizationKey}/draft-count-by-stars

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/draft-count-by-stars

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/draft-count-by-stars

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.

Returns​

return_parsed=True (default) — the output of parse_on3_rdb; pass return_as_pandas=True for a pandas.DataFrame.

No returns table is published for this endpoint: no committed capture with rows, and the response type is only heuristically mapped (x-source: call-site); names derived from the OpenAPI response type matched parse_on3_rdb's output on only 7 of the 9 checkable endpoints, so none are published.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_draft_count_by_stars(organization_key=1867)

Last validated n/a.

on3_organizations_draft_count_by_year​

GET /rdb/v1/organizations/{organizationKey}/draft-count-by-year

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/draft-count-by-year

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/draft-count-by-year

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.
pagepageYpage query parameter.
pageSizepage_sizeYpageSize query parameter.

Returns​

return_parsed=True (default) — the output of parse_on3_rdb; pass return_as_pandas=True for a pandas.DataFrame.

No returns table is published for this endpoint: no committed capture with rows, and the response type is only heuristically mapped (x-source: call-site); names derived from the OpenAPI response type matched parse_on3_rdb's output on only 7 of the 9 checkable endpoints, so none are published.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_draft_count_by_year(organization_key=1867)

Last validated n/a.

on3_organizations_draft_ranking_summary​

GET /rdb/v1/organizations/{organizationKey}/draft-ranking-summary

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/draft-ranking-summary

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/draft-ranking-summary

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.
yearyearYyear query parameter.

Returns​

return_parsed=True (default) — the output of parse_on3_rdb; pass return_as_pandas=True for a pandas.DataFrame.

No returns table is published for this endpoint: no committed capture with rows, and the response type is only heuristically mapped (x-source: call-site); names derived from the OpenAPI response type matched parse_on3_rdb's output on only 7 of the 9 checkable endpoints, so none are published.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_draft_ranking_summary(organization_key=1867)

Last validated n/a.

on3_organizations_drafted_players​

GET /rdb/v1/organizations/{organizationKey}/drafted-players

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/drafted-players

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/drafted-players

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.
pagepageYpage query parameter.
pageSizepage_sizeYpageSize query parameter.

Returns​

return_parsed=True (default) — the output of parse_on3_rdb; pass return_as_pandas=True for a pandas.DataFrame.

No returns table is published for this endpoint: no committed capture with rows, and the response type is only heuristically mapped (x-source: call-site); names derived from the OpenAPI response type matched parse_on3_rdb's output on only 7 of the 9 checkable endpoints, so none are published.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_drafted_players(organization_key=1867)

Last validated n/a.

on3_organizations_drafts_by_stars_summary​

GET /rdb/v1/organizations/{organizationKey}/drafts-by-stars-summary

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/drafts-by-stars-summary

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/drafts-by-stars-summary

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.
yearyearYyear query parameter.

Returns​

return_parsed=True (default) — the output of parse_on3_rdb; pass return_as_pandas=True for a pandas.DataFrame.

No returns table is published for this endpoint: no committed capture with rows, and the response type is only heuristically mapped (x-source: call-site); names derived from the OpenAPI response type matched parse_on3_rdb's output on only 7 of the 9 checkable endpoints, so none are published.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_drafts_by_stars_summary(organization_key=1867)

Last validated n/a.

on3_organizations_roster​

GET /rdb/v1/organizations/{organizationKey}/roster

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/roster

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/roster

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.
sportKeysport_keyYsportKey query parameter.
yearyearYyear query parameter.
pagepageYpage query parameter.
pageSizepage_sizeYpageSize query parameter.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
pso_keyintegerOn3 player-sport-organization (PSO) key for the roster entry.
statuscharacterRoster status label On3 attaches to the player (usually null).
nil_valuecharacterPlayer's On3 NIL valuation in dollars.
rpmcharacterNested On3 Recruiting Prediction Machine (RPM) data for the player (stringified).
industry_comparisoncharacterNested comparison of the player's On3 rating against the industry-consensus rating (stringified).
player_keyintegerOn3 numeric key of the player.
player_recruitment_keynumericOn3 key of the player's active recruitment record.
player_first_namecharacterFirst name of the player.
player_last_namecharacterLast name of the player.
player_full_namecharacterFull name of the player.
player_slugcharacterURL slug of the player's On3 profile.
player_date_of_birthcharacterDate of birth of the player (ISO timestamp string).
player_ageintegerAge of the player in years, when known.
player_high_school_namecharacterHigh-school display name on the player's record.
player_high_school_keyintegerOn3 numeric key of the player's high school.
player_high_school_full_namecharacterFull name of the player's high school (e.g. 'Alabama Crimson Tide').
player_high_school_name_2characterHigh-school display name on the player's record (json_normalize de-duplication suffix).
player_high_school_known_ascharacterCommon short name of the player's high school, when On3 lists one.
player_high_school_mascotcharacterMascot of the player's high school.
player_high_school_abbreviationcharacterAbbreviation of the player's high school.
player_high_school_asset_urlcharacterConvenience CDN URL of the player's high school's logo.
player_high_school_default_asset_keyintegerOn3 asset key of the player's high school's logo asset.
player_high_school_default_asset_domain_overridecharacterCDN domain override for the player's high school's logo asset (usually null).
player_high_school_default_asset_domaincharacterCDN domain serving the player's high school's logo asset.
player_high_school_default_asset_source_overridecharacterSource-path override for the player's high school's logo asset (usually null).
player_high_school_default_asset_sourcecharacterCDN-relative source path of the player's high school's logo asset.
player_high_school_default_asset_titlecharacterEditorial title attached to the player's high school's logo asset.
player_high_school_default_asset_descriptioncharacterEditorial description attached to the player's high school's logo asset (usually null).
player_high_school_default_asset_captioncharacterEditorial caption attached to the player's high school's logo asset (usually null).
player_high_school_default_asset_categorycharacterEditorial category label of the player's high school's logo asset (usually null).
player_high_school_default_asset_alt_textcharacterAccessibility alt text of the player's high school's logo asset (usually null).
player_high_school_default_asset_heightintegerPixel height of the player's high school's logo asset.
player_high_school_default_asset_widthintegerPixel width of the player's high school's logo asset.
player_high_school_default_asset_asset_typecharacterOn3 asset-type discriminator of the player's high school's logo asset (e.g. Image).
player_high_school_default_asset_file_systemcharacterStorage file-system flag of the player's high school's logo asset.
player_high_school_default_asset_pathcharacterStorage path of the player's high school's logo asset.
player_high_school_default_asset_typecharacterMedia type field of the player's high school's logo asset (file extension, e.g. png).
player_high_school_default_asset_thumbnailcharacterThumbnail variant of the player's high school's logo asset (video assets; usually null).
player_high_school_default_asset_durationintegerDuration of the player's high school's logo asset when it is a video (usually null or 0).
player_high_school_default_asset_mime_typecharacterMIME type of the player's high school's logo asset.
player_high_school_slugcharacterURL slug of the player's high school on On3.
player_high_school_primary_colorcharacterPrimary hex color of the player's high school.
player_high_school_org_typecharacterOrganization type label of the player's high school (e.g. HighSchool, College).
player_high_school_org_type_enumcharacterOrganization type enum of the player's high school (same vocabulary as org_type).
player_high_school_divisioncharacterDivision or classification of the player's high school (e.g. NCAA-FB).
player_high_school_site_keyscharacterJSON-encoded On3 site keys covering the player's high school (usually null).
player_high_school_url_slugcharacterURL slug variant of the player's high school's page, with the key appended.
player_hometown_keyintegerOn3 numeric key of the player's home town.
player_hometown_namecharacterHome town of the player as On3 lists it.
player_hometown_abbrcharacterAbbreviated home town of the player (city, state).
player_state_keyintegerOn3 numeric key of the player's home state.
player_state_namecharacterName of the player's home state.
player_state_abbrcharacterState abbreviation of the player's home town.
player_early_enrolleelogicalWhether the player early-enrolled at college.
player_early_signeelogicalWhether the player signed during the early signing period.
player_default_asset_keyintegerOn3 asset key of the player's headshot asset.
player_default_asset_domain_overridecharacterCDN domain override for the player's headshot asset (usually null).
player_default_asset_domaincharacterCDN domain serving the player's headshot asset.
player_default_asset_source_overridecharacterSource-path override for the player's headshot asset (usually null).
player_default_asset_sourcecharacterCDN-relative source path of the player's headshot asset.
player_default_asset_titlecharacterEditorial title attached to the player's headshot asset.
player_default_asset_descriptioncharacterEditorial description attached to the player's headshot asset (usually null).
player_default_asset_captioncharacterEditorial caption attached to the player's headshot asset (usually null).
player_default_asset_categorycharacterEditorial category label of the player's headshot asset (usually null).
player_default_asset_alt_textcharacterAccessibility alt text of the player's headshot asset (usually null).
player_default_asset_heightintegerPixel height of the player's headshot asset.
player_default_asset_widthintegerPixel width of the player's headshot asset.
player_default_asset_asset_typecharacterOn3 asset-type discriminator of the player's headshot asset (e.g. Image).
player_default_asset_file_systemcharacterStorage file-system flag of the player's headshot asset.
player_default_asset_pathcharacterStorage path of the player's headshot asset.
player_default_asset_typecharacterMedia type field of the player's headshot asset (file extension, e.g. png).
player_default_asset_thumbnailcharacterThumbnail variant of the player's headshot asset (video assets; usually null).
player_default_asset_durationintegerDuration of the player's headshot asset when it is a video (usually null or 0).
player_default_asset_mime_typecharacterMIME type of the player's headshot asset.
player_class_yearintegerHigh-school graduating class year of the player.
player_class_rankcharacterAcademic class standing of the player (e.g. Senior, RedShirt Senior).
player_position_keyintegerOn3 numeric key of the player's position.
player_position_namecharacterName of the player's position (e.g. Quarterback).
player_position_abbrcharacterAbbreviation of the player's position (e.g. QB).
player_default_sportcharacterNested primary-sport object of the player (null when On3 ships none).
player_jersey_numberintegerJersey number of the player, when listed.
player_heightcharacterHeight of the player: a formatted string (e.g. '6-8') or inches, depending on the endpoint.
player_weightintegerWeight of the player in pounds.
player_divisioncharacterDivision of the player's current organization (e.g. NCAA-FB, NCAA-BK).
player_athlete_verifiedlogicalWhether the player's athlete profile is verified by On3.
player_prospect_verifiedlogicalWhether the player's prospect measurables are verified by On3.
player_tiercharacterOn3 profile tier of the player (e.g. Star).
organization_keyintegerOn3 numeric key of the program.
organization_full_namecharacterFull name of the program (e.g. 'Alabama Crimson Tide').
organization_namecharacterShort name of the program.
organization_known_ascharacterCommon short name of the program, when On3 lists one.
organization_mascotcharacterMascot of the program.
organization_abbreviationcharacterAbbreviation of the program.
organization_asset_urlcharacterConvenience CDN URL of the program's logo.
organization_default_asset_keyintegerOn3 asset key of the program's logo asset.
organization_default_asset_domain_overridecharacterCDN domain override for the program's logo asset (usually null).
organization_default_asset_domaincharacterCDN domain serving the program's logo asset.
organization_default_asset_source_overridecharacterSource-path override for the program's logo asset (usually null).
organization_default_asset_sourcecharacterCDN-relative source path of the program's logo asset.
organization_default_asset_titlecharacterEditorial title attached to the program's logo asset.
organization_default_asset_descriptioncharacterEditorial description attached to the program's logo asset (usually null).
organization_default_asset_captioncharacterEditorial caption attached to the program's logo asset (usually null).
organization_default_asset_categorycharacterEditorial category label of the program's logo asset (usually null).
organization_default_asset_alt_textcharacterAccessibility alt text of the program's logo asset (usually null).
organization_default_asset_heightintegerPixel height of the program's logo asset.
organization_default_asset_widthintegerPixel width of the program's logo asset.
organization_default_asset_asset_typecharacterOn3 asset-type discriminator of the program's logo asset (e.g. Image).
organization_default_asset_file_systemcharacterStorage file-system flag of the program's logo asset.
organization_default_asset_pathcharacterStorage path of the program's logo asset.
organization_default_asset_typecharacterMedia type field of the program's logo asset (file extension, e.g. png).
organization_default_asset_thumbnailcharacterThumbnail variant of the program's logo asset (video assets; usually null).
organization_default_asset_durationintegerDuration of the program's logo asset when it is a video (usually null or 0).
organization_default_asset_mime_typecharacterMIME type of the program's logo asset.
organization_slugcharacterURL slug of the program on On3.
organization_primary_colorcharacterPrimary hex color of the program.
organization_org_typecharacterOrganization type label of the program (e.g. HighSchool, College).
organization_org_type_enumcharacterOrganization type enum of the program (same vocabulary as org_type).
organization_divisioncharacterDivision or classification of the program (e.g. NCAA-FB).
organization_site_keyscharacterJSON-encoded On3 site keys covering the program (usually null).
organization_url_slugcharacterURL slug variant of the program's page, with the key appended.
rating_keyintegerOn3 key of the On3 rating record.
rating_ratingintegerNumeric value of the On3 rating (0-100 scale).
rating_starsintegerStar rating of the On3 rating (2-5).
rating_national_rankintegerNational rank of the On3 rating.
rating_position_rankintegerPosition rank of the On3 rating.
rating_state_rankintegerState rank of the On3 rating.
rating_position_abbrcharacterPosition abbreviation the On3 rating was assigned at.
rating_state_abbrcharacterState abbreviation the On3 rating was assigned in.
rating_five_star_pluslogicalFive-star-plus flag on the On3 rating.
rating_nearly_five_star_pluslogicalNear-five-star-plus flag on the On3 rating.
rating_consensus_ratingnumericIndustry-consensus numeric rating paired with the On3 rating (0-100 scale).
rating_consensus_starsintegerIndustry-consensus star rating paired with the On3 rating (2-5).
rating_consensus_national_rankintegerIndustry-consensus national rank paired with the On3 rating.
rating_consensus_position_rankintegerIndustry-consensus position rank paired with the On3 rating.
rating_consensus_state_rankintegerIndustry-consensus state rank paired with the On3 rating.
rating_yearintegerRanking cycle year of the On3 rating.
rating_sport_keyintegerOn3 numeric key of the sport the On3 rating is in.
rating_sport_namecharacterName of the sport the On3 rating is in (e.g. Football).
rating_sport_abbrcharacterAbbreviation of the sport the On3 rating is in.
roster_rating_keynumericOn3 key of the On3 roster rating record.
roster_rating_ratingnumericNumeric value of the On3 roster rating (0-100 scale).
roster_rating_starsnumericStar rating of the On3 roster rating (2-5).
roster_rating_national_rankcharacterNational rank of the On3 roster rating.
roster_rating_position_ranknumericPosition rank of the On3 roster rating.
roster_rating_state_rankcharacterState rank of the On3 roster rating.
roster_rating_position_abbrcharacterPosition abbreviation the On3 roster rating was assigned at.
roster_rating_state_abbrcharacterState abbreviation the On3 roster rating was assigned in.
roster_rating_five_star_pluscharacterFive-star-plus flag on the On3 roster rating.
roster_rating_nearly_five_star_pluscharacterNear-five-star-plus flag on the On3 roster rating.
roster_rating_consensus_ratingcharacterIndustry-consensus numeric rating paired with the On3 roster rating (0-100 scale).
roster_rating_consensus_starsnumericIndustry-consensus star rating paired with the On3 roster rating (2-5).
roster_rating_consensus_national_rankcharacterIndustry-consensus national rank paired with the On3 roster rating.
roster_rating_consensus_position_rankcharacterIndustry-consensus position rank paired with the On3 roster rating.
roster_rating_consensus_state_rankcharacterIndustry-consensus state rank paired with the On3 roster rating.
roster_rating_yearnumericRanking cycle year of the On3 roster rating.
roster_rating_sport_keynumericOn3 numeric key of the sport the On3 roster rating is in.
roster_rating_sport_namecharacterName of the sport the On3 roster rating is in (e.g. Football).
roster_rating_sport_abbrcharacterAbbreviation of the sport the On3 roster rating is in.
roster_ratingcharacterNested On3 roster rating object for the player (stringified).
nil_value_keynumericOn3 key of the player's NIL valuation record.
nil_value_nil_statuscharacterStatus of the NIL valuation (e.g. Normal).
nil_value_total_valuenumericThe NIL valuation in US dollars.
nil_value_ranknumericOverall rank of the NIL valuation across On3's NIL 100.
nil_value_group_ranknumericRank of the NIL valuation within its group (sport or position).
nil_value_whispercharacterOn3 whisper valuation (reported deal value) behind the NIL valuation, in US dollars.
status_typecharacterType of the recruiting status (e.g. Committed, Signed, Enrolled, None).
status_datecharacterDate the recruiting status took effect (ISO timestamp string).
status_committed_assetcharacterNested asset of the committed-to program (the recruiting status; usually null).
status_transferred_assetcharacterNested asset of the program transferred to (the recruiting status; usually null).
status_decommitted_assetcharacterNested asset of the program decommitted from (the recruiting status; usually null).
status_transfer_enteredcharacterDate the player entered the transfer portal (the recruiting status; null when never entered).
status_transfer_withdrawncharacterDate the player withdrew from the transfer portal (the recruiting status; null when never withdrawn).
status_recruitment_yearnumericRecruiting-cycle year the recruiting status belongs to.
status_short_term_signeecharacterShort-term-signee flag of the recruiting status (null when not applicable).
status_transfercharacterTransfer flag of the recruiting status (null when not applicable).
status_draftcharacterDraft flag of the recruiting status (null when not applicable).
status_expected_to_transfercharacterExpected-to-transfer flag of the recruiting status (null when not applicable).

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_roster(organization_key=1867)

Last validated n/a.

on3_organizations_roster_header​

GET /rdb/v1/organizations/{organizationKey}/roster-header

Endpoint URL: GET https://api.on3.com/public/rdb/v1/organizations/{organization_key}/roster-header

Valid URL: https://api.on3.com/public/rdb/v1/organizations/1867/roster-header

API ParameterPythonPatternRequiredNullableDescription
organization_keyorganization_keyYorganization_key path parameter.
sportKeysport_keyYsportKey query parameter.
yearyearYyear query parameter.

Returns​

return_parsed=True (default) — a tidy polars.DataFrame with the columns below; pass return_as_pandas=True for a pandas.DataFrame.

col_nametypedescription
talent_rankcharacterProgram's current national roster-talent rank per On3.
prev_talent_rankcharacterProgram's roster-talent rank in the previous cycle.
conference_rankcharacterProgram's roster-talent rank within its conference.
prev_conference_rankcharacterProgram's conference roster-talent rank in the previous cycle.
average_ratingcharacterAverage On3 rating across the roster.
prev_average_ratingcharacterAverage On3 roster rating in the previous cycle.
average_nil_valuenumericAverage On3 NIL valuation across the roster, in dollars.
total_nil_valueintegerTotal On3 NIL valuation across the roster, in dollars.
head_coach_keyintegerOn3 numeric key of the head coach.
head_coach_first_namecharacterFirst name of the head coach.
head_coach_last_namecharacterLast name of the head coach.
head_coach_known_as_namecharacterPreferred name of the head coach, when it differs from the given name.
head_coach_full_namecharacterFull name of the head coach.
head_coach_slugcharacterURL slug of the head coach's On3 profile.
head_coach_default_asset_keyintegerOn3 asset key of the head coach's headshot asset.
head_coach_default_asset_domain_overridecharacterCDN domain override for the head coach's headshot asset (usually null).
head_coach_default_asset_domaincharacterCDN domain serving the head coach's headshot asset.
head_coach_default_asset_source_overridecharacterSource-path override for the head coach's headshot asset (usually null).
head_coach_default_asset_sourcecharacterCDN-relative source path of the head coach's headshot asset.
head_coach_default_asset_titlecharacterEditorial title attached to the head coach's headshot asset.
head_coach_default_asset_descriptioncharacterEditorial description attached to the head coach's headshot asset (usually null).
head_coach_default_asset_captioncharacterEditorial caption attached to the head coach's headshot asset (usually null).
head_coach_default_asset_categorycharacterEditorial category label of the head coach's headshot asset (usually null).
head_coach_default_asset_alt_textcharacterAccessibility alt text of the head coach's headshot asset (usually null).
head_coach_default_asset_heightintegerPixel height of the head coach's headshot asset.
head_coach_default_asset_widthintegerPixel width of the head coach's headshot asset.
head_coach_default_asset_asset_typecharacterOn3 asset-type discriminator of the head coach's headshot asset (e.g. Image).
head_coach_default_asset_file_systemcharacterStorage file-system flag of the head coach's headshot asset.
head_coach_default_asset_pathcharacterStorage path of the head coach's headshot asset.
head_coach_default_asset_typecharacterMedia type field of the head coach's headshot asset (file extension, e.g. png).
head_coach_default_asset_thumbnailcharacterThumbnail variant of the head coach's headshot asset (video assets; usually null).
head_coach_default_asset_durationintegerDuration of the head coach's headshot asset when it is a video (usually null or 0).
head_coach_default_asset_mime_typecharacterMIME type of the head coach's headshot asset.
head_coach_organization_keyintegerOn3 numeric key of the head coach's program.
head_coach_organization_full_namecharacterFull name of the head coach's program (e.g. 'Alabama Crimson Tide').
head_coach_organization_namecharacterShort name of the head coach's program.
head_coach_organization_known_ascharacterCommon short name of the head coach's program, when On3 lists one.
head_coach_organization_mascotcharacterMascot of the head coach's program.
head_coach_organization_abbreviationcharacterAbbreviation of the head coach's program.
head_coach_organization_asset_urlcharacterConvenience CDN URL of the head coach's program's logo.
head_coach_organization_default_asset_keyintegerOn3 asset key of the head coach's program's logo asset.
head_coach_organization_default_asset_domain_overridecharacterCDN domain override for the head coach's program's logo asset (usually null).
head_coach_organization_default_asset_domaincharacterCDN domain serving the head coach's program's logo asset.
head_coach_organization_default_asset_source_overridecharacterSource-path override for the head coach's program's logo asset (usually null).
head_coach_organization_default_asset_sourcecharacterCDN-relative source path of the head coach's program's logo asset.
head_coach_organization_default_asset_titlecharacterEditorial title attached to the head coach's program's logo asset.
head_coach_organization_default_asset_descriptioncharacterEditorial description attached to the head coach's program's logo asset (usually null).
head_coach_organization_default_asset_captioncharacterEditorial caption attached to the head coach's program's logo asset (usually null).
head_coach_organization_default_asset_categorycharacterEditorial category label of the head coach's program's logo asset (usually null).
head_coach_organization_default_asset_alt_textcharacterAccessibility alt text of the head coach's program's logo asset (usually null).
head_coach_organization_default_asset_heightintegerPixel height of the head coach's program's logo asset.
head_coach_organization_default_asset_widthintegerPixel width of the head coach's program's logo asset.
head_coach_organization_default_asset_asset_typecharacterOn3 asset-type discriminator of the head coach's program's logo asset (e.g. Image).
head_coach_organization_default_asset_file_systemcharacterStorage file-system flag of the head coach's program's logo asset.
head_coach_organization_default_asset_pathcharacterStorage path of the head coach's program's logo asset.
head_coach_organization_default_asset_typecharacterMedia type field of the head coach's program's logo asset (file extension, e.g. png).
head_coach_organization_default_asset_thumbnailcharacterThumbnail variant of the head coach's program's logo asset (video assets; usually null).
head_coach_organization_default_asset_durationintegerDuration of the head coach's program's logo asset when it is a video (usually null or 0).
head_coach_organization_default_asset_mime_typecharacterMIME type of the head coach's program's logo asset.
head_coach_organization_slugcharacterURL slug of the head coach's program on On3.
head_coach_organization_primary_colorcharacterPrimary hex color of the head coach's program.
head_coach_organization_org_typecharacterOrganization type label of the head coach's program (e.g. HighSchool, College).
head_coach_organization_org_type_enumcharacterOrganization type enum of the head coach's program (same vocabulary as org_type).
head_coach_organization_divisioncharacterDivision or classification of the head coach's program (e.g. NCAA-FB).
head_coach_organization_site_keyscharacterJSON-encoded On3 site keys covering the head coach's program (usually null).
head_coach_organization_url_slugcharacterURL slug variant of the head coach's program's page, with the key appended.
head_coach_primary_position_keyintegerOn3 numeric key of the head coach's primary position.
head_coach_primary_position_namecharacterName of the head coach's primary position (e.g. Quarterback).
head_coach_primary_position_abbrcharacterAbbreviation of the head coach's primary position (e.g. QB).
head_coach_secondary_positioncharacterSecondary position of the head coach, when listed.
head_coach_org_season_countintegerSeasons the head coach has spent at the program.
head_coach_years_activeintegerYears the head coach has been active in coaching.

return_parsed=False — the raw JSON Dict payload, unparsed.

Example​

on3_organizations_roster_header(organization_key=1867)

Last validated n/a.