API/Variables

From MyChances

(Back to main API wiki)

Thanks for choosing the MyChances.net College Admissions Prediction API. This page contains the variables you are allowed to post to us to retrieve results from our prediction engine. You are not required to post every variable, but please contact us if you have any questions about your proposed list of variables. We built the prediction engine so that even a small set of posted variables will still result in predictions.

Please note, this list will continue to grow. All predictions will be backwards-compatible as we add new allowed variables, ie you will not be required to add more variables just because we add them to our API.

Also note, you must post the variables in the exact same format - same spelling, capitalization, etc. as listed under "Permitted Variable(s):".

Contents 1 API KEY 2 ACT 3 APs 4 Class Size 5 College ID 6 Convicted 7 Country 8 Decile 9 Ethnicity 10 Father's Education 11 First Language 12 High School 13 High School Type 14 ipeds 15 Misconduct 16 Mother's Education 17 National Merit Awards 18 Primary Language 19 PSAT Composite Score 20 SAT 21 SAT II / Subject Tests 22 Sex 23 State 24 Unweighted GPA 25 Weighted GPA 26 Weighted GPA Max 27 Zip Code

API KEY

• Description: You must have a valid API key to make a call, and it must be posted in an array along with all other variables.

• Permitted Variable(s):
  • api_key

• Allowed Values: String

ACT

• Description: ACT composite score

• Permitted Variable(s):
  • act

• Allowed Values: Integer, up to 36

APs

• Description: The AP examination scores

• Permitted Variable(s):
  • ap_art_history
  • ap_biology
  • ap_calculus_ab
  • ap_calculus_bc
  • ap_chemistry
  • ap_chinese
  • ap_comparative_government
  • ap_computer_science_a
  • ap_computer_science_ab
  • ap_english_language
  • ap_english_literature
  • ap_environmental_science
  • ap_european_history
  • ap_french_language
  • ap_french_literature
  • ap_german_language
  • ap_human_geography
  • ap_italian
  • ap_japanese
  • ap_latin_literature
  • ap_latin_vergil
  • ap_macroeconomics
  • ap_microeconomics
  • ap_music
  • ap_physics_b
  • ap_physics_c
  • ap_psychology
  • ap_spanish_language
  • ap_spanish_literature
  • ap_statistics
  • ap_studio_art
  • ap_us_government
  • ap_us_history
  • ap_world_history

• Allowed Values: Integer, up to 5

Class Size

• Description: The size of the class the student is in.

• Permitted Variable(s):
  • class_size

• Allowed Values: Integer

College ID

• Description: This is the key that MyChances must receive to return a prediction for the appropriate college. (Note: you may alternatively use the 'ipeds' variable, listed below, instead.) Once you sign up for an API Key, we will send you a table with our college IDs/names/states/cities, so you can sync your database and receive predictions.

• Permitted Variable(s):
  • college_id

• Allowed Values: Integer

Convicted

• Description: Has the student every been convicted of a crime? 1=yes, 0=no

• Permitted Variable(s):
  • convicted

• Allowed Values: Binary (1=yes, 0=no)

Country

• Description: The three letter country code of which the student is a citizen. (eg 'USA')

• Permitted Variable(s):
  • country

• Allowed Values: Three character string, all caps.

Decile

• Description: The decile in which the student falls in his or her class.

• Permitted Variable(s):
  • decile

• Allowed Values: Case-sensitive strings of the following:
  • Unknown
  • Class Not Ranked
  • Valedictorian
  • Salutatorian
  • {Percentile class rank}
    • Examples:
    • 0 (for valedictorian)
    • 10 (for someone in the top 10% of their class)
    • 80 (for someone in the top 80% of their class, i.e., the bottom 20%)

Ethnicity

• Description: The student's ethnicity

• Permitted Variable(s):
  • ethnicity

• Allowed Values: string, of the following:
  • None Indicated
  • African-American
  • Caucasian
  • East Asian
  • Hispanic
  • Middle-Eastern
  • Native American
  • South Asian
  • Other

Father's Education

• Description: The level of education reached by the student's father

• Permitted Variable(s):
  • fatherEducation

• Allowed Values: string, of the following:
  • none
  • hs
  • 2y
  • 4y
  • master
  • professional
  • phd

First Language

• Description: The student's first language

• Permitted Variable(s):
  • firstlanguage

• Allowed Values: string, of the following:
  • English
  • Spanish
  • Other

High School

• Description: The MyChances ID for the student's high school. If you would like to send us the HS, please request our table so you can sync your HS database with ours.

• Permitted Variable(s):
  • hs_id

• Allowed Values: string, of the following: integer

High School Type

• Description: Type of high school the student attends

• Permitted Variable(s):
  • hs_type

• Allowed Values: string, of the following:
  • Boarding School
  • Home School
  • Magnet School
  • Parochial School
  • Private School
  • Public School
  • Other

ipeds

• Description: This is one of the allowed identification keys that MyChances requires to return a prediction for the appropriate college. (Note: you may alternatively use the 'college_id' variable, listed above.) IPEDS IDs are standardized and maintained by the NCES in the United States. Note that no foreign colleges have IPEDS IDs.

• Permitted Variable(s):
  • ipeds

• Allowed Values: Integer

Misconduct

• Description: Has the student ever been on probation, suspended, removed, dismissed, or expelled from a high school due to academic or behavioral misconduct?

• Permitted Variable(s):
  • misconduct

• Allowed Values: Binary (1=yes, 0=no)

Mother's Education

• Description: The level of education reached by the student's mother

• Permitted Variable(s):
  • motherEducation

• Allowed Values: string, of the following:
  • none
  • hs
  • 2y
  • 4y
  • master
  • professional
  • phd

National Merit Awards

• Description: National Merit & National Achievement

• Permitted Variable(s):
  • nationalmerit

• Allowed Values: string, of the following:
  • none
  • commended
  • semifinalist
  • finalist
  • scholar
  • hispanic
  • blackparticipant
  • blacksemifinalist
  • blackscholar

Primary Language

• Description: The primary language spoken at the student's home

• Permitted Variable(s):
  • primarylanguage

• Allowed Values: string, of the following:
  • English
  • Spanish
  • Other

PSAT Composite Score

• Description: The student's PSAT composite score

• Permitted Variable(s):
  • psat

• Allowed Values: Integer,
  • min value of 60
  • max value of 240

SAT

• Description: The SAT examination scores

• Permitted Variable(s):
  • sat_math
  • sat_verbal
  • sat_writing

• Allowed Values: Integer,
  • min value 200
  • max value 800

SAT II / Subject Tests

• Description: The SAT Subject Test scores

• Permitted Variable(s):
  • sat2_biology
  • sat2_chemistry
  • sat2_chinese
  • sat2_french
  • sat2_french_listening
  • sat2_german
  • sat2_german_listening
  • sat2_hebrew
  • sat2_italian
  • sat2_japanese_listening
  • sat2_korean_listening
  • sat2_latin
  • sat2_lit
  • sat2_math_1
  • sat2_math_2
  • sat2_physics
  • sat2_spanish
  • sat2_spanish_listening
  • sat2_us_hist
  • sat2_world_hist

• Allowed Values: Integer,
  • min value 200
  • max value 800

Sex

• Description: The sex of the student.

• Permitted Variable(s):
  • sex

• Allowed Values:
  • M
  • F

State

• Description: The two letter code of the student's state of residence.

• Permitted Variable(s):
  • state

• Allowed Values:
  • (the 2 letter code of the state of residence, ie 'CA')
  • additionally can send 'Other/Foreign' if either foreign or not born in one of the 50 states.

Unweighted GPA

• Description: Unweighted GPA on 4 point scale

• Permitted Variable(s):
  • unweighted_gpa

• Allowed Values:
  • decimal value with a max value of 4.00

Weighted GPA

• Description: Weighted GPA on 4 point scale

• Permitted Variable(s):
  • weighted_gpa

• Allowed Values:
  • decimal value with a max value equal to weighted_gpa_max (below)

Weighted GPA Max

• Description: The maximum value of the weighted GPA on 4 point scale for the student's school.

• Permitted Variable(s):
  • weighted_gpa_max

• Allowed Values:
  • decimal value (maximum value possible at the school). weighted_gpa must not exceed this value.

Zip Code

• Description: The 5 digit zip code.

• Permitted Variable(s):
  • zip

• Allowed Values:
  • The 5 digit zip code, of the student's primary residence.