Skip to main content
Version: 0.1.5

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

on3_recruitment_primary_recruitment_evaluation​

GET /rdb/v1/recruitment/{recruitmentKey}/primary-recruitment-evaluation

Endpoint URL: GET https://api.on3.com/public/rdb/v1/recruitment/{recruitment_key}/primary-recruitment-evaluation

Valid URL: https://api.on3.com/public/rdb/v1/recruitment/270036/primary-recruitment-evaluation

API ParameterPythonPatternRequiredNullableDescription
recruitment_keyrecruitment_keyYrecruitment_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; 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_recruitment_primary_recruitment_evaluation(recruitment_key=270036)

Last validated n/a.

on3_recruitment_recruitment_evaluations​

GET /rdb/v1/recruitment/{recruitmentKey}/recruitment-evaluations

Endpoint URL: GET https://api.on3.com/public/rdb/v1/recruitment/{recruitment_key}/recruitment-evaluations

Valid URL: https://api.on3.com/public/rdb/v1/recruitment/270036/recruitment-evaluations

API ParameterPythonPatternRequiredNullableDescription
recruitment_keyrecruitment_keyYrecruitment_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: its committed capture has 0 rows, so the parser emits no columns; 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_recruitment_recruitment_evaluations(recruitment_key=270036)

Last validated n/a.

on3_recruitments_latest_rpm_picks​

Latest RPM (prediction) picks feed — paged {list,pagination}

Endpoint URL: GET https://api.on3.com/public/rdb/v1/recruitments/latest-rpm-picks

Valid URL: https://api.on3.com/public/rdb/v1/recruitments/latest-rpm-picks

API ParameterPythonPatternRequiredNullableDescription
orgKeyorg_keyYorgKey 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
pick_keyintegerOn3 key of the RPM pick.
pick_organizationcharacterNested program object the RPM pick predicts (stringified; usually null).
pick_yearintegerRecruiting class year the RPM pick applies to (0 when unset).
pick_date_addedcharacterTimestamp the RPM pick was logged (ISO string).
pick_expertcharacterNested expert object of the RPM pick (stringified; usually null).
pick_confidencenumericConfidence the expert attached to the RPM pick, in percent.
pick_article_linkcharacterOn3 article link accompanying the RPM pick, when any.
pick_premiumlogicalWhether the RPM pick is behind the On3+ paywall.
pick_correctcharacterWhether the RPM pick proved correct ('True'/'False' string; null while open).
pick_days_correctnumericDays the RPM pick stood correct.
pick_flipped_from_organizationcharacterProgram the recruit flipped from when the RPM pick was logged, when any.
pick_previous_confidencecharacterConfidence of the expert's previous pick on the recruit, when any.
pick_previous_date_addedcharacterTimestamp of the expert's previous pick on the recruit (a 0001-01-01 sentinel when none).
pick_typecharacterType of the RPM pick (e.g. NewLeader, Flip).
pick_expert_accuracynumericLifetime pick accuracy of the pick's expert, in percent.
pick_top_teamscharacterJSON-encoded list of the recruit's top teams at the time of the RPM pick.
player_keyintegerOn3 numeric key of the player.
player_recruitment_keyintegerOn3 key of the player's active recruitment record.
player_namecharacterDisplay name of the player.
player_slugcharacterURL slug of the player's On3 profile.
player_high_school_namecharacterHigh-school display name on the player's record.
player_high_schoolcharacterHigh-school display name on the player's record.
player_home_town_namecharacterHome town of the player as On3 lists it (e.g. 'Belleville, MI').
player_early_enrolleelogicalWhether the player early-enrolled at college.
player_early_signeelogicalWhether the player signed during the early signing period.
player_default_asset_urlcharacterConvenience CDN URL of the player's headshot.
player_class_yearcharacterHigh-school graduating class year of the player.
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_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_position_abbreviationcharacterPosition abbreviation on the player's record.
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_ratingcharacterOn3 rating of the player (0-100 scale), when published.
player_roster_ratingcharacterOn3 roster (transfer-portal-adjusted) rating of the player, when published.
player_commit_status_typecharacterType of the player's commitment status (e.g. Committed, Signed, Enrolled, None).
player_commit_status_short_term_signeelogicalShort-term-signee flag of the player's commitment status (null when not applicable).
player_commit_status_datecharacterDate the player's commitment status took effect (ISO timestamp string).
player_commit_status_committed_asset_keyintegerOn3 numeric key of the player's commitment status's committed-to program.
player_commit_status_committed_asset_urlcharacterCDN URL of the player's commitment status's committed-to program's logo.
player_commit_status_committed_asset_slugcharacterURL slug of the player's commitment status's committed-to program on On3.
player_commit_status_committed_asset_full_namecharacterFull name of the player's commitment status's committed-to program (e.g. 'Alabama Crimson Tide').
player_commit_status_committed_asset_res_keyintegerOn3 asset key of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_asset_res_domain_overridecharacterCDN domain override for the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_asset_res_domaincharacterCDN domain serving the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_asset_res_source_overridecharacterSource-path override for the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_asset_res_sourcecharacterCDN-relative source path of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_asset_res_titlecharacterEditorial title attached to the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_asset_res_descriptioncharacterEditorial description attached to the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_asset_res_captioncharacterEditorial caption attached to the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_asset_res_categorycharacterEditorial category label of the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_asset_res_alt_textcharacterAccessibility alt text of the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_asset_res_heightintegerPixel height of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_asset_res_widthintegerPixel width of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_asset_res_asset_typecharacterOn3 asset-type discriminator of the player's commitment status's committed-to program's logo asset (e.g. Image).
player_commit_status_committed_asset_res_file_systemcharacterStorage file-system flag of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_asset_res_pathcharacterStorage path of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_asset_res_typecharacterMedia type field of the player's commitment status's committed-to program's logo asset (file extension, e.g. png).
player_commit_status_committed_asset_res_thumbnailcharacterThumbnail variant of the player's commitment status's committed-to program's logo asset (video assets; usually null).
player_commit_status_committed_asset_res_durationintegerDuration of the player's commitment status's committed-to program's logo asset when it is a video (usually null or 0).
player_commit_status_committed_asset_res_mime_typecharacterMIME type of the player's commitment status's committed-to program's logo asset.
player_commit_status_transferred_asset_keyintegerOn3 numeric key of the player's commitment status's program transferred to.
player_commit_status_transferred_asset_urlcharacterCDN URL of the player's commitment status's program transferred to's logo.
player_commit_status_transferred_asset_slugcharacterURL slug of the player's commitment status's program transferred to on On3.
player_commit_status_transferred_asset_full_namecharacterFull name of the player's commitment status's program transferred to (e.g. 'Alabama Crimson Tide').
player_commit_status_transferred_asset_res_keyintegerOn3 asset key of the player's commitment status's program transferred to's logo asset.
player_commit_status_transferred_asset_res_domain_overridecharacterCDN domain override for the player's commitment status's program transferred to's logo asset (usually null).
player_commit_status_transferred_asset_res_domaincharacterCDN domain serving the player's commitment status's program transferred to's logo asset.
player_commit_status_transferred_asset_res_source_overridecharacterSource-path override for the player's commitment status's program transferred to's logo asset (usually null).
player_commit_status_transferred_asset_res_sourcecharacterCDN-relative source path of the player's commitment status's program transferred to's logo asset.
player_commit_status_transferred_asset_res_titlecharacterEditorial title attached to the player's commitment status's program transferred to's logo asset.
player_commit_status_transferred_asset_res_descriptioncharacterEditorial description attached to the player's commitment status's program transferred to's logo asset (usually null).
player_commit_status_transferred_asset_res_captioncharacterEditorial caption attached to the player's commitment status's program transferred to's logo asset (usually null).
player_commit_status_transferred_asset_res_categorycharacterEditorial category label of the player's commitment status's program transferred to's logo asset (usually null).
player_commit_status_transferred_asset_res_alt_textcharacterAccessibility alt text of the player's commitment status's program transferred to's logo asset (usually null).
player_commit_status_transferred_asset_res_heightintegerPixel height of the player's commitment status's program transferred to's logo asset.
player_commit_status_transferred_asset_res_widthintegerPixel width of the player's commitment status's program transferred to's logo asset.
player_commit_status_transferred_asset_res_asset_typecharacterOn3 asset-type discriminator of the player's commitment status's program transferred to's logo asset (e.g. Image).
player_commit_status_transferred_asset_res_file_systemcharacterStorage file-system flag of the player's commitment status's program transferred to's logo asset.
player_commit_status_transferred_asset_res_pathcharacterStorage path of the player's commitment status's program transferred to's logo asset.
player_commit_status_transferred_asset_res_typecharacterMedia type field of the player's commitment status's program transferred to's logo asset (file extension, e.g. png).
player_commit_status_transferred_asset_res_thumbnailcharacterThumbnail variant of the player's commitment status's program transferred to's logo asset (video assets; usually null).
player_commit_status_transferred_asset_res_durationintegerDuration of the player's commitment status's program transferred to's logo asset when it is a video (usually null or 0).
player_commit_status_transferred_asset_res_mime_typecharacterMIME type of the player's commitment status's program transferred to's logo asset.
player_commit_status_committed_organization_keyintegerOn3 key of the committed-to program (the player's commitment status).
player_commit_status_committed_organization_full_namecharacterFull name of the player's commitment status's committed-to program (e.g. 'Alabama Crimson Tide').
player_commit_status_committed_organization_namecharacterShort name of the player's commitment status's committed-to program.
player_commit_status_committed_organization_mascotcharacterMascot of the player's commitment status's committed-to program.
player_commit_status_committed_organization_abbreviationcharacterAbbreviation of the player's commitment status's committed-to program.
player_commit_status_committed_organization_asset_urlcharacterCDN URL of the committed-to program's logo (the player's commitment status).
player_commit_status_committed_organization_asset_keyintegerOn3 asset key of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_asset_domain_overridecharacterCDN domain override for the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_organization_asset_domaincharacterCDN domain serving the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_asset_source_overridecharacterSource-path override for the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_organization_asset_sourcecharacterCDN-relative source path of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_asset_titlecharacterEditorial title attached to the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_asset_descriptioncharacterEditorial description attached to the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_organization_asset_captioncharacterEditorial caption attached to the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_organization_asset_categorycharacterEditorial category label of the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_organization_asset_alt_textcharacterAccessibility alt text of the player's commitment status's committed-to program's logo asset (usually null).
player_commit_status_committed_organization_asset_heightintegerPixel height of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_asset_widthintegerPixel width of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_asset_asset_typecharacterOn3 asset-type discriminator of the player's commitment status's committed-to program's logo asset (e.g. Image).
player_commit_status_committed_organization_asset_file_systemcharacterStorage file-system flag of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_asset_pathcharacterStorage path of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_asset_typecharacterMedia type field of the player's commitment status's committed-to program's logo asset (file extension, e.g. png).
player_commit_status_committed_organization_asset_thumbnailcharacterThumbnail variant of the player's commitment status's committed-to program's logo asset (video assets; usually null).
player_commit_status_committed_organization_asset_durationintegerDuration of the player's commitment status's committed-to program's logo asset when it is a video (usually null or 0).
player_commit_status_committed_organization_asset_mime_typecharacterMIME type of the player's commitment status's committed-to program's logo asset.
player_commit_status_committed_organization_slugcharacterURL slug of the committed-to program (the player's commitment status).
player_commit_status_committed_organization_primary_colorcharacterPrimary hex color of the player's commitment status's committed-to program.
player_commit_status_class_rankcharacterAcademic class standing recorded on the player's commitment status (e.g. Senior).
player_commit_status_transfer_enteredcharacterDate the player entered the transfer portal (the player's commitment status; null when never entered).
player_commit_status_recruitment_yearcharacterRecruiting-cycle year the player's commitment status belongs to.
player_commit_status_decommitted_assetcharacterNested asset of the program decommitted from (the player's commitment status; usually null).
player_commit_status_transferlogicalTransfer flag of the player's commitment status (null when not applicable).
player_commit_status_expected_to_transferlogicalExpected-to-transfer flag of the player's commitment status (null when not applicable).
player_commit_status_recruitment_keyintegerOn3 key of the recruitment record the player's commitment status belongs to.
player_commit_status_withdrawn_transferlogicalWhether the player withdrew from the transfer portal (the player's commitment status).
player_commit_status_withdrawn_transfer_datecharacterDate the player withdrew from the transfer portal (the player's commitment status; null when never withdrawn).
player_predictionscharacterJSON-encoded On3 RPM (Recruiting Prediction Machine) entries for the player.
player_nil_statuscharacterOn3 NIL valuation status of the player (e.g. Normal).
player_nil_valueintegerOn3 NIL valuation of the player in US dollars.
player_sportcharacterNested sport object of the player (null when On3 ships none).
pick_organization_asset_url_keynumericOn3 asset key behind the RPM pick's program's logo link.
pick_organization_asset_url_urlcharacterFull CDN URL of the RPM pick's program's logo link.
pick_organization_asset_url_slugcharacterURL slug of the program the RPM pick's program's logo link belongs to.
pick_organization_asset_url_full_namecharacterFull name of the program the RPM pick's program's logo link belongs to.
pick_organization_full_namecharacterFull name of the RPM pick's program (e.g. 'Alabama Crimson Tide').
pick_organization_keynumericOn3 numeric key of the RPM pick's program.
pick_organization_namecharacterShort name of the RPM pick's program.
pick_organization_mascotcharacterMascot of the RPM pick's program.
pick_organization_abbreviationcharacterAbbreviation of the RPM pick's program.
pick_organization_asset_keynumericOn3 asset key of the RPM pick's program's logo asset.
pick_organization_asset_domain_overridecharacterCDN domain override for the RPM pick's program's logo asset (usually null).
pick_organization_asset_domaincharacterCDN domain serving the RPM pick's program's logo asset.
pick_organization_asset_source_overridecharacterSource-path override for the RPM pick's program's logo asset (usually null).
pick_organization_asset_sourcecharacterCDN-relative source path of the RPM pick's program's logo asset.
pick_organization_asset_titlecharacterEditorial title attached to the RPM pick's program's logo asset.
pick_organization_asset_descriptioncharacterEditorial description attached to the RPM pick's program's logo asset (usually null).
pick_organization_asset_captioncharacterEditorial caption attached to the RPM pick's program's logo asset (usually null).
pick_organization_asset_categorycharacterEditorial category label of the RPM pick's program's logo asset (usually null).
pick_organization_asset_alt_textcharacterAccessibility alt text of the RPM pick's program's logo asset (usually null).
pick_organization_asset_heightnumericPixel height of the RPM pick's program's logo asset.
pick_organization_asset_widthnumericPixel width of the RPM pick's program's logo asset.
pick_organization_asset_asset_typecharacterOn3 asset-type discriminator of the RPM pick's program's logo asset (e.g. Image).
pick_organization_asset_file_systemcharacterStorage file-system flag of the RPM pick's program's logo asset.
pick_organization_asset_pathcharacterStorage path of the RPM pick's program's logo asset.
pick_organization_asset_typecharacterMedia type field of the RPM pick's program's logo asset (file extension, e.g. png).
pick_organization_asset_thumbnailcharacterThumbnail variant of the RPM pick's program's logo asset (video assets; usually null).
pick_organization_asset_durationnumericDuration of the RPM pick's program's logo asset when it is a video (usually null or 0).
pick_organization_asset_mime_typecharacterMIME type of the RPM pick's program's logo asset.
pick_organization_slugcharacterURL slug of the RPM pick's program on On3.
pick_organization_primary_colorcharacterPrimary hex color of the RPM pick's program.
pick_expert_keynumericOn3 key of the pick's expert.
pick_expert_namecharacterDisplay name of the pick's expert.
pick_expert_nice_namecharacterURL slug of the pick's expert.
pick_expert_twitter_handlecharacterTwitter/X handle of the pick's expert, when listed.
pick_expert_instagram_handlecharacterInstagram handle of the pick's expert, when listed.
pick_expert_youtube_urlcharacterYouTube URL of the pick's expert, when listed.
pick_expert_biocharacterBiography text of the pick's expert, when listed.
pick_expert_job_titlecharacterJob title of the pick's expert, when listed.
pick_expert_site_affiliationcharacterOn3 site the pick's expert writes for, when listed.
pick_expert_profile_picturecharacterProfile picture of the pick's expert (nested; usually null).
pick_expert_profile_picture_response_keynumericOn3 asset key of the expert's profile-picture asset.
pick_expert_profile_picture_response_domain_overridecharacterCDN domain override for the expert's profile-picture asset (usually null).
pick_expert_profile_picture_response_domaincharacterCDN domain serving the expert's profile-picture asset.
pick_expert_profile_picture_response_source_overridecharacterSource-path override for the expert's profile-picture asset (usually null).
pick_expert_profile_picture_response_sourcecharacterCDN-relative source path of the expert's profile-picture asset.
pick_expert_profile_picture_response_titlecharacterEditorial title attached to the expert's profile-picture asset.
pick_expert_profile_picture_response_descriptioncharacterEditorial description attached to the expert's profile-picture asset (usually null).
pick_expert_profile_picture_response_captioncharacterEditorial caption attached to the expert's profile-picture asset (usually null).
pick_expert_profile_picture_response_categorycharacterEditorial category label of the expert's profile-picture asset (usually null).
pick_expert_profile_picture_response_alt_textcharacterAccessibility alt text of the expert's profile-picture asset (usually null).
pick_expert_profile_picture_response_heightcharacterPixel height of the expert's profile-picture asset.
pick_expert_profile_picture_response_widthcharacterPixel width of the expert's profile-picture asset.
pick_expert_profile_picture_response_asset_typecharacterOn3 asset-type discriminator of the expert's profile-picture asset (e.g. Image).
pick_expert_profile_picture_response_file_systemcharacterStorage file-system flag of the expert's profile-picture asset.
pick_expert_profile_picture_response_pathcharacterStorage path of the expert's profile-picture asset.
pick_expert_profile_picture_response_typecharacterMedia type field of the expert's profile-picture asset (file extension, e.g. png).
pick_expert_profile_picture_response_thumbnailcharacterThumbnail variant of the expert's profile-picture asset (video assets; usually null).
pick_expert_profile_picture_response_durationnumericDuration of the expert's profile-picture asset when it is a video (usually null or 0).
pick_expert_profile_picture_response_mime_typecharacterMIME type of the expert's profile-picture asset.
player_high_school_keynumericOn3 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_keynumericOn3 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_heightnumericPixel height of the player's high school's logo asset.
player_high_school_default_asset_widthnumericPixel 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_durationnumericDuration 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_rating_keynumericOn3 key of the player's On3 rating record.
player_rating_ratingnumericNumeric value of the player's On3 rating (0-100 scale).
player_rating_starsnumericStar rating of the player's On3 rating (2-5).
player_rating_national_ranknumericNational rank of the player's On3 rating.
player_rating_position_ranknumericPosition rank of the player's On3 rating.
player_rating_state_ranknumericState rank of the player's On3 rating.
player_rating_position_abbrcharacterPosition abbreviation the player's On3 rating was assigned at.
player_rating_state_abbrcharacterState abbreviation the player's On3 rating was assigned in.
player_rating_five_star_pluscharacterFive-star-plus flag on the player's On3 rating.

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

Example​

on3_recruitments_latest_rpm_picks()

Last validated n/a.

on3_recruitments_profile​

GET /rdb/v1/recruitments/{recKey}/profile

Endpoint URL: GET https://api.on3.com/public/rdb/v1/recruitments/{rec_key}/profile

Valid URL: https://api.on3.com/public/rdb/v1/recruitments/270036/profile

API ParameterPythonPatternRequiredNullableDescription
rec_keyrec_keyYrec_key path 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
class_yearintegerRecruiting class year of the recruitment.
high_schoolcharacterHigh-school display name on the record.
home_towncharacterHome town as On3 lists it (e.g. 'Pewaukee, WI').
rating_keyintegerOn3 key of the On3 rating record.
rating_ratingnumericNumeric 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.
committed_status_typecharacterType of the commitment status (e.g. Committed, Signed, Enrolled, None).
committed_status_short_term_signeelogicalShort-term-signee flag of the commitment status (null when not applicable).
committed_status_datecharacterDate the commitment status took effect (ISO timestamp string).
committed_status_committed_asset_keyintegerOn3 numeric key of the committed-to program.
committed_status_committed_asset_urlcharacterCDN URL of the committed-to program's logo.
committed_status_committed_asset_slugcharacterURL slug of the committed-to program on On3.
committed_status_committed_asset_full_namecharacterFull name of the committed-to program (e.g. 'Alabama Crimson Tide').
committed_status_committed_asset_res_keyintegerOn3 asset key of the committed-to program's logo asset.
committed_status_committed_asset_res_domain_overridecharacterCDN domain override for the committed-to program's logo asset (usually null).
committed_status_committed_asset_res_domaincharacterCDN domain serving the committed-to program's logo asset.
committed_status_committed_asset_res_source_overridecharacterSource-path override for the committed-to program's logo asset (usually null).
committed_status_committed_asset_res_sourcecharacterCDN-relative source path of the committed-to program's logo asset.
committed_status_committed_asset_res_titlecharacterEditorial title attached to the committed-to program's logo asset.
committed_status_committed_asset_res_descriptioncharacterEditorial description attached to the committed-to program's logo asset (usually null).
committed_status_committed_asset_res_captioncharacterEditorial caption attached to the committed-to program's logo asset (usually null).
committed_status_committed_asset_res_categorycharacterEditorial category label of the committed-to program's logo asset (usually null).
committed_status_committed_asset_res_alt_textcharacterAccessibility alt text of the committed-to program's logo asset (usually null).
committed_status_committed_asset_res_heightintegerPixel height of the committed-to program's logo asset.
committed_status_committed_asset_res_widthintegerPixel width of the committed-to program's logo asset.
committed_status_committed_asset_res_asset_typecharacterOn3 asset-type discriminator of the committed-to program's logo asset (e.g. Image).
committed_status_committed_asset_res_file_systemcharacterStorage file-system flag of the committed-to program's logo asset.
committed_status_committed_asset_res_pathcharacterStorage path of the committed-to program's logo asset.
committed_status_committed_asset_res_typecharacterMedia type field of the committed-to program's logo asset (file extension, e.g. png).
committed_status_committed_asset_res_thumbnailcharacterThumbnail variant of the committed-to program's logo asset (video assets; usually null).
committed_status_committed_asset_res_durationintegerDuration of the committed-to program's logo asset when it is a video (usually null or 0).
committed_status_committed_asset_res_mime_typecharacterMIME type of the committed-to program's logo asset.
committed_status_transferred_assetcharacterNested asset of the program transferred to (the commitment status; usually null).
committed_status_transferred_asset_rescharacterNested logo asset of the program transferred to (the commitment status; usually null).
committed_status_committed_organization_keyintegerOn3 key of the committed-to program (the commitment status).
committed_status_committed_organization_full_namecharacterFull name of the commitment status's committed-to program (e.g. 'Alabama Crimson Tide').
committed_status_committed_organization_namecharacterShort name of the commitment status's committed-to program.
committed_status_committed_organization_mascotcharacterMascot of the commitment status's committed-to program.
committed_status_committed_organization_abbreviationcharacterAbbreviation of the commitment status's committed-to program.
committed_status_committed_organization_asset_urlcharacterCDN URL of the committed-to program's logo (the commitment status).
committed_status_committed_organization_assetcharacterNested logo asset of the committed-to program (the commitment status; stringified or null).
committed_status_committed_organization_slugcharacterURL slug of the committed-to program (the commitment status).
committed_status_committed_organization_primary_colorcharacterPrimary hex color of the commitment status's committed-to program.
committed_status_class_rankcharacterAcademic class standing recorded on the commitment status (e.g. Senior).
committed_status_transfer_enteredcharacterDate the player entered the transfer portal (the commitment status; null when never entered).
committed_status_recruitment_yearcharacterRecruiting-cycle year the commitment status belongs to.
committed_status_decommitted_assetcharacterNested asset of the program decommitted from (the commitment status; usually null).
committed_status_transferlogicalTransfer flag of the commitment status (null when not applicable).
committed_status_expected_to_transferlogicalExpected-to-transfer flag of the commitment status (null when not applicable).
committed_status_recruitment_keyintegerOn3 key of the recruitment record the commitment status belongs to.
committed_status_withdrawn_transferlogicalWhether the player withdrew from the transfer portal (the commitment status).
committed_status_withdrawn_transfer_datecharacterDate the player withdrew from the transfer portal (the commitment status; null when never withdrawn).
high_school_org_keyintegerOn3 numeric key of the high school.
high_school_org_full_namecharacterFull name of the high school (e.g. 'Alabama Crimson Tide').
high_school_org_namecharacterShort name of the high school.
high_school_org_known_ascharacterCommon short name of the high school, when On3 lists one.
high_school_org_mascotcharacterMascot of the high school.
high_school_org_abbreviationcharacterAbbreviation of the high school.
high_school_org_asset_urlcharacterConvenience CDN URL of the high school's logo.
high_school_org_default_asset_keyintegerOn3 asset key of the high school's logo asset.
high_school_org_default_asset_domain_overridecharacterCDN domain override for the high school's logo asset (usually null).
high_school_org_default_asset_domaincharacterCDN domain serving the high school's logo asset.
high_school_org_default_asset_source_overridecharacterSource-path override for the high school's logo asset (usually null).
high_school_org_default_asset_sourcecharacterCDN-relative source path of the high school's logo asset.
high_school_org_default_asset_titlecharacterEditorial title attached to the high school's logo asset.
high_school_org_default_asset_descriptioncharacterEditorial description attached to the high school's logo asset (usually null).
high_school_org_default_asset_captioncharacterEditorial caption attached to the high school's logo asset (usually null).
high_school_org_default_asset_categorycharacterEditorial category label of the high school's logo asset (usually null).
high_school_org_default_asset_alt_textcharacterAccessibility alt text of the high school's logo asset (usually null).
high_school_org_default_asset_heightintegerPixel height of the high school's logo asset.
high_school_org_default_asset_widthintegerPixel width of the high school's logo asset.
high_school_org_default_asset_asset_typecharacterOn3 asset-type discriminator of the high school's logo asset (e.g. Image).
high_school_org_default_asset_file_systemcharacterStorage file-system flag of the high school's logo asset.
high_school_org_default_asset_pathcharacterStorage path of the high school's logo asset.
high_school_org_default_asset_typecharacterMedia type field of the high school's logo asset (file extension, e.g. png).
high_school_org_default_asset_thumbnailcharacterThumbnail variant of the high school's logo asset (video assets; usually null).
high_school_org_default_asset_durationintegerDuration of the high school's logo asset when it is a video (usually null or 0).
high_school_org_default_asset_mime_typecharacterMIME type of the high school's logo asset.
high_school_org_slugcharacterURL slug of the high school on On3.
high_school_org_primary_colorcharacterPrimary hex color of the high school.
high_school_org_org_typecharacterOrganization type label of the high school (e.g. HighSchool, College).
high_school_org_org_type_enumcharacterOrganization type enum of the high school (same vocabulary as org_type).
high_school_org_divisioncharacterDivision or classification of the high school (e.g. NCAA-FB).
high_school_org_site_keyscharacterJSON-encoded On3 site keys covering the high school (usually null).
high_school_org_url_slugcharacterURL slug variant of the high school's page, with the key appended.

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

Example​

on3_recruitments_profile(rec_key=270036)

Last validated n/a.

on3_recruitments_rpm_picks​

GET /rdb/v1/recruitments/{recKey}/rpm-picks

Endpoint URL: GET https://api.on3.com/public/rdb/v1/recruitments/{rec_key}/rpm-picks

Valid URL: https://api.on3.com/public/rdb/v1/recruitments/270036/rpm-picks

API ParameterPythonPatternRequiredNullableDescription
rec_keyrec_keyYrec_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: its committed capture has 0 rows, so the parser emits no columns; 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_recruitments_rpm_picks(rec_key=270036)

Last validated n/a.

on3_recruitments_rpm_summary​

GET /rdb/v1/recruitments/{recKey}/rpm-summary

Endpoint URL: GET https://api.on3.com/public/rdb/v1/recruitments/{rec_key}/rpm-summary

Valid URL: https://api.on3.com/public/rdb/v1/recruitments/270036/rpm-summary

API ParameterPythonPatternRequiredNullableDescription
rec_keyrec_keyYrec_key path 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
predictionscharacterPer-team RPM prediction percentages for the recruitment, as a stringified list.
lockedlogicalWhether the RPM prediction for the recruitment is locked (no longer updating).

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

Example​

on3_recruitments_rpm_summary(rec_key=270036)

Last validated n/a.