Skip to main content

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

on3_commits_latest​

GET /rdb/v1/commits/latest

Endpoint URL: GET https://api.on3.com/public/rdb/v1/commits/latest

Valid URL: https://api.on3.com/public/rdb/v1/commits/latest

API ParameterPythonPatternRequiredNullableDescription
sportKeysport_keyYsportKey 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
keyintegerOn3 person key (stable athlete identifier) for the recruit.
recruitment_keyintegerOn3 recruitment key for the recruit's active recruitment.
namecharacterFull name of the recruit.
slugcharacterURL slug for the recruit's On3 profile.
high_school_namecharacterName of the recruit's high school.
home_town_namecharacterRecruit's hometown (city, state).
early_enrolleelogicalWhether the recruit early-enrolled at their college.
early_signeelogicalWhether the recruit signed during the early signing period.
default_asset_urlcharacterURL of the recruit's primary headshot image.
class_yearintegerRecruiting class (graduation) year of the recruit.
athlete_verifiedlogicalWhether On3 has verified the recruit's athletic identity.
prospect_verifiedlogicalWhether On3 has verified the recruit as a prospect.
position_abbreviationcharacterAbbreviated primary position of the recruit.
heightcharacterRecruit height (formatted string, e.g. "6-2").
weightintegerRecruit weight in pounds.
roster_ratingcharacterOn3 roster (transfer-portal-adjusted) rating for the recruit.
predictionscharacterList of recruiting-prediction entries (RPM picks) for the recruit.
nil_statuscharacterNested NIL (name/image/likeness) status object for the recruit.
nil_valueintegerOn3 NIL valuation for the recruit (US dollars).
high_school_keyintegerOn3 numeric key of the high school.
high_school_full_namecharacterFull name of the high school (with mascot).
high_school_name_2characterName field of the nested high-school object (json_normalize de-duplication of high_school_name).
high_school_known_ascharacterCommon short name of the high school, when On3 lists one.
high_school_mascotcharacterHigh-school mascot.
high_school_abbreviationcharacterHigh-school abbreviation.
high_school_asset_urlcharacterConvenience CDN URL of the high-school logo.
high_school_default_asset_keynumericOn3 asset key of the high school's logo asset.
high_school_default_asset_domain_overridecharacterCDN domain override for the high school's logo asset (usually null).
high_school_default_asset_domaincharacterCDN domain serving the high school's logo asset.
high_school_default_asset_source_overridecharacterSource-path override for the high school's logo asset (usually null).
high_school_default_asset_sourcecharacterCDN-relative source path of the high school's logo asset.
high_school_default_asset_titlecharacterEditorial title attached to the high school's logo asset.
high_school_default_asset_descriptioncharacterEditorial description attached to the high school's logo asset (usually null).
high_school_default_asset_captioncharacterEditorial caption attached to the high school's logo asset (usually null).
high_school_default_asset_categorycharacterEditorial category label of the high school's logo asset (usually null).
high_school_default_asset_alt_textcharacterAccessibility alt text of the high school's logo asset (usually null).
high_school_default_asset_heightnumericPixel height of the high school's logo asset.
high_school_default_asset_widthnumericPixel width of the high school's logo asset.
high_school_default_asset_asset_typecharacterOn3 asset-type discriminator of the high school's logo asset (e.g. Image).
high_school_default_asset_file_systemcharacterStorage file-system flag of the high school's logo asset.
high_school_default_asset_pathcharacterStorage path of the high school's logo asset.
high_school_default_asset_typecharacterMedia type field of the high school's logo asset (file extension, e.g. png).
high_school_default_asset_thumbnailcharacterThumbnail variant of the high school's logo asset (video assets; usually null).
high_school_default_asset_durationnumericDuration of the high school's logo asset when it is a video (usually null or 0).
high_school_default_asset_mime_typecharacterMIME type of the high school's logo asset.
high_school_slugcharacterURL slug of the high school on On3.
high_school_primary_colorcharacterPrimary hex color of the high school.
high_school_org_typecharacterOrganization type label of the school (e.g. HighSchool).
high_school_org_type_enumcharacterOrganization type enum of the school.
high_school_divisioncharacterDivision or classification of the high school, when listed.
high_school_site_keyscharacterJSON-encoded On3 site keys covering the school (usually null).
high_school_url_slugcharacterURL slug variant of the high-school page, with the key appended.
default_asset_keyintegerOn3 asset key of the default asset.
default_asset_domain_overridecharacterCDN domain override for the record's default asset (usually null).
default_asset_domaincharacterCDN domain serving the default asset.
default_asset_source_overridecharacterSource-path override for the default asset (usually null).
default_asset_sourcecharacterCDN-relative source path of the default asset.
default_asset_titlecharacterEditorial title attached to the default asset.
default_asset_descriptioncharacterEditorial description attached to the default asset (usually null).
default_asset_captioncharacterEditorial caption attached to the default asset (usually null).
default_asset_categorycharacterEditorial category label of the default asset (usually null).
default_asset_alt_textcharacterAccessibility alt text of the default asset (usually null).
default_asset_heightintegerPixel height of the default asset.
default_asset_widthintegerPixel width of the default asset.
default_asset_asset_typecharacterOn3 asset-type discriminator of the default asset (e.g. Image).
default_asset_file_systemcharacterStorage file-system flag of the default asset.
default_asset_pathcharacterStorage path of the default asset.
default_asset_typecharacterMedia type field of the default asset (file extension, e.g. png).
default_asset_thumbnailcharacterThumbnail variant of the default asset (video assets; usually null).
default_asset_durationintegerDuration of the default asset when it is a video (usually null or 0).
default_asset_mime_typecharacterMIME type of the default asset.
rating_keynumericOn3 key of the On3 rating record.
rating_ratingnumericNumeric value of the On3 rating (0-100 scale).
rating_starsnumericStar rating of the On3 rating (2-5).
rating_national_ranknumericNational rank of the On3 rating.
rating_position_ranknumericPosition rank of the On3 rating.
rating_state_ranknumericState 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_pluscharacterFive-star-plus flag on the On3 rating.
commit_status_typecharacterType of the commitment status (e.g. Committed, Signed, Enrolled, None).
commit_status_short_term_signeelogicalShort-term-signee flag of the commitment status (null when not applicable).
commit_status_datecharacterDate the commitment status took effect (ISO timestamp string).
commit_status_committed_asset_keyintegerOn3 numeric key of the commitment status's committed-to program.
commit_status_committed_asset_urlcharacterCDN URL of the commitment status's committed-to program's logo.
commit_status_committed_asset_slugcharacterURL slug of the commitment status's committed-to program on On3.
commit_status_committed_asset_full_namecharacterFull name of the commitment status's committed-to program (e.g. 'Alabama Crimson Tide').
commit_status_committed_asset_res_keyintegerOn3 asset key of the commitment status's committed-to program's logo asset.
commit_status_committed_asset_res_domain_overridecharacterCDN domain override for the commitment status's committed-to program's logo asset (usually null).
commit_status_committed_asset_res_domaincharacterCDN domain serving the commitment status's committed-to program's logo asset.
commit_status_committed_asset_res_source_overridecharacterSource-path override for the commitment status's committed-to program's logo asset (usually null).
commit_status_committed_asset_res_sourcecharacterCDN-relative source path of the commitment status's committed-to program's logo asset.
commit_status_committed_asset_res_titlecharacterEditorial title attached to the commitment status's committed-to program's logo asset.
commit_status_committed_asset_res_descriptioncharacterEditorial description attached to the commitment status's committed-to program's logo asset (usually null).
commit_status_committed_asset_res_captioncharacterEditorial caption attached to the commitment status's committed-to program's logo asset (usually null).
commit_status_committed_asset_res_categorycharacterEditorial category label of the commitment status's committed-to program's logo asset (usually null).
commit_status_committed_asset_res_alt_textcharacterAccessibility alt text of the commitment status's committed-to program's logo asset (usually null).
commit_status_committed_asset_res_heightintegerPixel height of the commitment status's committed-to program's logo asset.
commit_status_committed_asset_res_widthintegerPixel width of the commitment status's committed-to program's logo asset.
commit_status_committed_asset_res_asset_typecharacterOn3 asset-type discriminator of the commitment status's committed-to program's logo asset (e.g. Image).
commit_status_committed_asset_res_file_systemcharacterStorage file-system flag of the commitment status's committed-to program's logo asset.
commit_status_committed_asset_res_pathcharacterStorage path of the commitment status's committed-to program's logo asset.
commit_status_committed_asset_res_typecharacterMedia type field of the commitment status's committed-to program's logo asset (file extension, e.g. png).
commit_status_committed_asset_res_thumbnailcharacterThumbnail variant of the commitment status's committed-to program's logo asset (video assets; usually null).
commit_status_committed_asset_res_durationintegerDuration of the commitment status's committed-to program's logo asset when it is a video (usually null or 0).
commit_status_committed_asset_res_mime_typecharacterMIME type of the commitment status's committed-to program's logo asset.
commit_status_transferred_assetcharacterNested asset of the program transferred to (the commitment status; usually null).
commit_status_transferred_asset_rescharacterNested logo asset of the program transferred to (the commitment status; usually null).
commit_status_committed_organization_keyintegerOn3 key of the committed-to program (the commitment status).
commit_status_committed_organization_full_namecharacterFull name of the commitment status's committed-to program (e.g. 'Alabama Crimson Tide').
commit_status_committed_organization_namecharacterShort name of the commitment status's committed-to program.
commit_status_committed_organization_mascotcharacterMascot of the commitment status's committed-to program.
commit_status_committed_organization_abbreviationcharacterAbbreviation of the commitment status's committed-to program.
commit_status_committed_organization_asset_urlcharacterCDN URL of the committed-to program's logo (the commitment status).
commit_status_committed_organization_assetcharacterNested logo asset of the committed-to program (the commitment status; stringified or null).
commit_status_committed_organization_slugcharacterURL slug of the committed-to program (the commitment status).
commit_status_committed_organization_primary_colorcharacterPrimary hex color of the commitment status's committed-to program.
commit_status_class_rankcharacterAcademic class standing recorded on the commitment status (e.g. Senior).
commit_status_transfer_enteredcharacterDate the player entered the transfer portal (the commitment status; null when never entered).
commit_status_recruitment_yearintegerRecruiting-cycle year the commitment status belongs to.
commit_status_decommitted_assetcharacterNested asset of the program decommitted from (the commitment status; usually null).
commit_status_transferlogicalTransfer flag of the commitment status (null when not applicable).
commit_status_expected_to_transferlogicalExpected-to-transfer flag of the commitment status (null when not applicable).
commit_status_recruitment_keyintegerOn3 key of the recruitment record the commitment status belongs to.
commit_status_withdrawn_transferlogicalWhether the player withdrew from the transfer portal (the commitment status).
commit_status_withdrawn_transfer_datecharacterDate the player withdrew from the transfer portal (the commitment status; null when never withdrawn).
sport_keyintegerOn3 numeric key of the sport.
sport_namecharacterName of the sport (e.g. Football).
ratingcharacterOn3 rating for the recruit.
high_school_default_assetcharacterNested default-asset object of the high school (null when On3 ships none).

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

Example​

on3_commits_latest()

Last validated n/a.

on3_commits_organizations_latest_commits​

GET /rdb/v1/commits/organizations/{orgKey}/latest-commits

Endpoint URL: GET https://api.on3.com/public/rdb/v1/commits/organizations/{org_key}/latest-commits

Valid URL: https://api.on3.com/public/rdb/v1/commits/organizations/1867/latest-commits

API ParameterPythonPatternRequiredNullableDescription
org_keyorg_keyYorg_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 row has nested objects whose flattened column names depend on which are null in the data; 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_commits_organizations_latest_commits(org_key=1867)

Last validated n/a.

on3_commits_organizations_org_key​

GET /rdb/v1/commits/organizations/{orgKey}

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

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

API ParameterPythonPatternRequiredNullableDescription
org_keyorg_keyYorg_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_commits_organizations_org_key(org_key=1867)

Last validated n/a.