CFB — On3 Recruit Database (api.on3.com) — Collective
on3_collective_groups
GET /rdb/v1/collective-groups
Endpoint URL: GET https://api.on3.com/public/rdb/v1/collective-groups
Valid URL: https://api.on3.com/public/rdb/v1/collective-groups
| API Parameter | Python | Pattern | Required | Nullable | Description |
|---|---|---|---|---|---|
sportKey | sport_key | Y | sportKey query parameter. | ||
organizationKey | organization_key | Y | organizationKey query parameter. | ||
query | query | Y | query query parameter. | ||
page | page | Y | page query parameter. | ||
pageSize | page_size | Y | pageSize 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_name | type | description |
|---|---|---|
key | integer | On3 RDB key for the NIL collective group. |
name | character | Display name of the row's record. |
default_asset_key | integer | On3 asset key for the collective's primary logo image. |
social_asset_key | integer | On3 asset key for the collective's social-media image. |
organization_key | integer | On3 organization key of the school the collective supports. |
launch_date | character | Date the NIL collective launched. |
organization_type | character | Legal form of the collective (e.g. LLC, 501(c)(3)). |
twitter_handle | character | Collective's Twitter/X account handle. |
instagram_handle | character | Collective's Instagram account handle. |
tik_tok_handle | character | Collective's TikTok account handle. |
youtube_handle | character | Collective's YouTube channel handle. |
linked_in_handle | character | Collective's LinkedIn account handle. |
website_name | character | Display name of the collective's website. |
website_url | character | URL of the collective's website. |
mission_statement | character | Collective's stated mission, as published to On3. |
description | character | Free-text description or biography shipped by On3. |
annual_goal_amount | numeric | Collective's annual fundraising goal in dollars, as reported to On3. |
confirmed_raised_amount | numeric | Dollar amount the collective has confirmed raising, per On3. |
merged_into_group_key | integer | On3 key of the collective this group merged into, when applicable. |
merged_into_group | character | Nested On3 record for the collective this group merged into (stringified). |
slug | character | URL slug of the row's record on On3. |
founders | character | Founders of the collective, as a stringified list. |
sports | character | Sports the collective funds, as a stringified list. |
default_asset_key_2 | integer | Asset key repeated from the nested default-asset object (json_normalize de-duplication suffix). |
default_asset_domain_override | character | CDN domain override for the record's default asset (usually null). |
default_asset_domain | character | CDN domain serving the default asset. |
default_asset_source_override | character | Source-path override for the default asset (usually null). |
default_asset_source | character | CDN-relative source path of the default asset. |
default_asset_title | character | Editorial title attached to the default asset. |
default_asset_description | character | Editorial description attached to the default asset (usually null). |
default_asset_caption | character | Editorial caption attached to the default asset (usually null). |
default_asset_category | character | Editorial category label of the default asset (usually null). |
default_asset_alt_text | character | Accessibility alt text of the default asset (usually null). |
default_asset_height | integer | Pixel height of the default asset. |
default_asset_width | integer | Pixel width of the default asset. |
default_asset_asset_type | character | On3 asset-type discriminator of the default asset (e.g. Image). |
default_asset_file_system | character | Storage file-system flag of the default asset. |
default_asset_path | character | Storage path of the default asset. |
default_asset_type | character | Media type field of the default asset (file extension, e.g. png). |
default_asset_thumbnail | character | Thumbnail variant of the default asset (video assets; usually null). |
default_asset_duration | integer | Duration of the default asset when it is a video (usually null or 0). |
default_asset_mime_type | character | MIME type of the default asset. |
social_asset_key_2 | integer | Asset key repeated from the nested social-asset object (json_normalize de-duplication suffix). |
social_asset_domain_override | character | CDN domain override for the social-media asset (usually null). |
social_asset_domain | character | CDN domain serving the social-media asset. |
social_asset_source_override | character | Source-path override for the social-media asset (usually null). |
social_asset_source | character | CDN-relative source path of the social-media asset. |
social_asset_title | character | Editorial title attached to the social-media asset. |
social_asset_description | character | Editorial description attached to the social-media asset (usually null). |
social_asset_caption | character | Editorial caption attached to the social-media asset (usually null). |
social_asset_category | character | Editorial category label of the social-media asset (usually null). |
social_asset_alt_text | character | Accessibility alt text of the social-media asset (usually null). |
social_asset_height | integer | Pixel height of the social-media asset. |
social_asset_width | integer | Pixel width of the social-media asset. |
social_asset_asset_type | character | On3 asset-type discriminator of the social-media asset (e.g. Image). |
social_asset_file_system | character | Storage file-system flag of the social-media asset. |
social_asset_path | character | Storage path of the social-media asset. |
social_asset_type | character | Media type field of the social-media asset (file extension, e.g. png). |
social_asset_thumbnail | character | Thumbnail variant of the social-media asset (video assets; usually null). |
social_asset_duration | integer | Duration of the social-media asset when it is a video (usually null or 0). |
social_asset_mime_type | character | MIME type of the social-media asset. |
organization_key_2 | integer | Organization key repeated from the nested organization object (json_normalize de-duplication suffix). |
organization_full_name | character | Full name of the program (e.g. 'Alabama Crimson Tide'). |
organization_name | character | Short name of the program. |
organization_known_as | character | Common short name of the program, when On3 lists one. |
organization_mascot | character | Mascot of the program. |
organization_abbreviation | character | Abbreviation of the program. |
organization_asset_url | character | Convenience CDN URL of the program's logo. |
organization_default_asset_key | integer | On3 asset key of the program's logo asset. |
organization_default_asset_domain_override | character | CDN domain override for the program's logo asset (usually null). |
organization_default_asset_domain | character | CDN domain serving the program's logo asset. |
organization_default_asset_source_override | character | Source-path override for the program's logo asset (usually null). |
organization_default_asset_source | character | CDN-relative source path of the program's logo asset. |
organization_default_asset_title | character | Editorial title attached to the program's logo asset. |
organization_default_asset_description | character | Editorial description attached to the program's logo asset (usually null). |
organization_default_asset_caption | character | Editorial caption attached to the program's logo asset (usually null). |
organization_default_asset_category | character | Editorial category label of the program's logo asset (usually null). |
organization_default_asset_alt_text | character | Accessibility alt text of the program's logo asset (usually null). |
organization_default_asset_height | integer | Pixel height of the program's logo asset. |
organization_default_asset_width | integer | Pixel width of the program's logo asset. |
organization_default_asset_asset_type | character | On3 asset-type discriminator of the program's logo asset (e.g. Image). |
organization_default_asset_file_system | character | Storage file-system flag of the program's logo asset. |
organization_default_asset_path | character | Storage path of the program's logo asset. |
organization_default_asset_type | character | Media type field of the program's logo asset (file extension, e.g. png). |
organization_default_asset_thumbnail | character | Thumbnail variant of the program's logo asset (video assets; usually null). |
organization_default_asset_duration | integer | Duration of the program's logo asset when it is a video (usually null or 0). |
organization_default_asset_mime_type | character | MIME type of the program's logo asset. |
organization_slug | character | URL slug of the program on On3. |
organization_primary_color | character | Primary hex color of the program. |
organization_org_type | character | Organization type label of the program (e.g. HighSchool, College). |
organization_org_type_enum | character | Organization type enum of the program (same vocabulary as org_type). |
organization_division | character | Division or classification of the program (e.g. NCAA-FB). |
organization_site_keys | character | JSON-encoded On3 site keys covering the program (usually null). |
organization_url_slug | character | URL slug variant of the program's page, with the key appended. |
return_parsed=False — the raw JSON Dict payload, unparsed.
Example
on3_collective_groups()
Last validated n/a.
on3_collective_groups_deals
GET /rdb/v1/collective-groups/{key}/deals
Endpoint URL: GET https://api.on3.com/public/rdb/v1/collective-groups/{key}/deals
Valid URL: https://api.on3.com/public/rdb/v1/collective-groups/1/deals
| API Parameter | Python | Pattern | Required | Nullable | Description |
|---|---|---|---|---|---|
key | key | Y | key path parameter. | ||
page | page | Y | page query parameter. | ||
pageSize | page_size | Y | pageSize 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_collective_groups_deals(key=1)
Last validated n/a.
on3_collective_groups_key
GET /rdb/v1/collective-groups/{key}
Endpoint URL: GET https://api.on3.com/public/rdb/v1/collective-groups/{key}
Valid URL: https://api.on3.com/public/rdb/v1/collective-groups/1
| API Parameter | Python | Pattern | Required | Nullable | Description |
|---|---|---|---|---|---|
key | key | Y | 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_collective_groups_key(key=1)
Last validated n/a.