package.json

{
  "name": "marketplace_api",
  "version": "1.0.0",
  "description": "_AboutThe_Marketplace_API_delivers_data_that_helps_users_find_and_evaluate_health_care_insurance_plans_providers_and_coverage_information_on_the_marketplace__Its_used_by__HealthCare_gov_httpshealthcare_gov_and_other_third_party_services__Request_an_API_token__here_httpsdeveloper_cms_govmarketplace_apikey_request_html_or_learn_more_from__the_developer_site_httpsdeveloper_cms_govmarketplace_api__RetentionMarketplace_API_data_includes_at_minimum_the_last_three_years_of_data__LimitationsAPI_keys_are_rate_limited__This_rate_limit_is_passed_along_in_the_Header_information_provided__If_you_have_concerns_with_the_rate_limit_please_reach_out_to_the__Marketplace_API_team_mailtomarketplace_apicms_provider_directory_uservoice_com__QuickstartThis_section_will_cover_a_short_workflow_for_a_common_scenario__looking_up_insurance_plans_for_a_persons_household_with_premiums_and_estimated_tax_credits_obtaining_details_about_a_particular_plan_and_looking_up_the_drug_coverage_for_a_specific_plan__Other_endpoints___like_looking_up_doctors_and_providers_or_getting_recent_state_medicaid_information__are_covered_in_the_docs__Search_for_health_insurance_plansWe_begin_by_searching_for_the_health_insurance_plans_for_a_27_year_old_woman_living_in_North_Carolina_by_posting_a_single_person_household_to_the_plan_search_endpointapikeyd687412e7b53146b2631dc01974ad0a4__rate_limited_test_keycurl___request_POST_____url_httpsmarketplace_api_healthcare_govapiv1planssearchapikeyapikey_____header_content_type_applicationjson_____data_____household_______income_52000______people____________________age_27__________aptc_eligible_true__________gender_Female__________uses_tobacco_false______________________market_Individual____place_______countyfips_37057______state_NC______zipcode_27360________year_2019This_POST_request_returns_health_insurance_information_and_pricing_estimates_for_the_plans_for_which_she_can_sign_up__More_discussion_about_building_the_household_JSON_object_can_be_found_later_on_this_page__Dont_know_the_county__FIPS_httpsen_m_wikipedia_orgwikiFIPS_county_code_code_To_look_it_up_for_this_persons_zip_code_we_use_the_counties_by_zip_endpoint_apikeyd687412e7b53146b2631dc01974ad0a4zipcode27360curl_httpsmarketplace_api_healthcare_govapiv1countiesbyzipzipcodeapikeyapikeyThis_helps_gather_the_necessary_information_to_build_the_household_object_to_submit_to_the_API__Get_details_about_a_specific_health_insurance_planWith_a_plan_search_completed_lets_look_more_closely_at_a_particular_plan__For_example_Blue_Cross_Blue_Shield_of_North_Carolina_Blue_Value_Catastrophic_was_one_of_the_first_returned_from_the_example_above__We_will_use_it_as_an_example_to_drill_downapikeyd687412e7b53146b2631dc01974ad0a4planid11512NC0100031year2019curl_httpsmarketplace_api_healthcare_govapiv1plansplanidyearyearapikeyapikeyUsing_this_endpoint_will_provide_more_granular_information_about_the_particular_plan_for_a_searching_user_like_issuer_information_cost_sharing_deductibles_eligible_dependents_website_urls_quality_ratings_and_more__Standard_PlansSome_plans_are_considered_standard_plans__These_can_be_identified_in_the_results_of_a_plan_search_or_plan_details_endpoint___If_a_plan_has_a_design_type_that_is_one_of_the_following_it_is_considered_a_standard_plan_DESIGN1_DESIGN2_DESIGN3_DESIGN4_DESIGN5___If_a_plan_has_a_design_type_of_NOT_APPLICABLE_then_it_is_not_considered_a_standard_plan__Get_drug_coverage_information_about_a_health_insurance_planNow_that_we_have_a_plan_of_interest_lets_look_up_what_drugs_it_covers__We_want_to_know_if_ibuprofen_is_covered_under_the_insurance_plan__First_we_can_mimic_a_user_interaction_with_an_autocomplete_for_ibuprofen_for_a_typeahead_apikeyd687412e7b53146b2631dc01974ad0a4queryibuprofcurl_httpsmarketplace_api_healthcare_govapiv1drugsautocompleteqqueryapikeyapikeyAmong_other_things_this_provides_us_with_an_RxCUI_a_unique_identifier_for_a_clinical_drug__We_can_use_it_along_with_the_plan_id_to_query_the_API_for_whether_or_not_ibuprofen_is_covered_under_this_planapikeyd687412e7b53146b2631dc01974ad0a4drugs1049589planids11512NC0100031year2019curl_httpsmarketplace_api_healthcare_govapiv1drugscoveredyearyeardrugsdrugsplanidsplanidsapikeyapikeyThe_API_confirms_that_ibuprofen_is_covered__More_information_about_householdsThe_household_in_the_example_above_was_sufficient_to_query_Marketplace_API_but_there_are_more_optional_fields_that_can_provide_more_accurate_search_results_and_premium_estimates_or_can_be_used_by_application_developers_to_specify_scenarios__For_example_if_a_household_does_not_live_together_certain_plans_may_no_longer_be_eligible_to_them_We_begin_with_an_example_describing_what_some_of_the_less_intuitive_fields_means__Heres_the_JSON_of_a_fully_filled_in_household_using_all_possible_features__aptc_override_288_61__household_____effective_date_2019_05_01____has_married_couple_true____income_52000____unemployment_received_Adult____people________________age_27________dob_1992_01_01________aptc_eligible_true________does_not_cohabitate_false________gender_Female________has_mec_false________is_parent_false________is_pregnant_false________relationship_Self________uses_tobacco_false________utilization_Medium____________________age_25________dob_1994_03_03________aptc_eligible_true________does_not_cohabitate_false________gender_Male________has_mec_false________is_parent_false________is_pregnant_false________relationship_Spouse________uses_tobacco_false________utilization_Medium______________market_Individual__place_____countyfips_37057____state_NC____zipcode_27360____year_2019_APTC_OverrideThe_aptc_override_is_an_optional_override_to_specify_the_Advanced_Premium_Tax_Credit_for_a_user_if_the_exact_value_is_already_known__For_persons_in_the_household_aptc_eligible_denotes_if_the_person_is_eligible_for_the_Advanced_Premium_Tax_Credit__Unemployment_ReceivedAs_part_of_the_American_Rescue_Plan_if_the_household_has_received_unemployment_benefits_during_2021_the_household_income_must_be_capped_to_133_of_the_Federal_Poverty_Level_for_the_household_size_in_APTC_and_CSR_estimations___If_the_recipient_is_an_adult_tax_payer_both_ATPC_and_CSRs_will_be_affected___If_only_a_tax_dependent_received_unemployment_the_only_effect_will_be_to_CSR_eligibility_If_both_an_adult_and_dependent_have_received_unemployment_Adult_should_be_passed_so_that_the_maximum_APTC_and_CSRs_are_received_This_field_defaults_to_None_if_not_included_and_only_affects_the_2021_market_year__Effective_DateThis_is_the_date_a_plan_or_coverage_goes_into_effect_and_is_used_in_premium_calculations_and_determining_eligibility__If_omitted_the_value_defaults_to_the_effective_date_of_the_plan_which_is_generally_Jan_1_of_the_market_year__The_effective_date_is_required_to_correctly_calculate_the_number_of_months_since_an_individual_has_used_tobacco__The_number_of_months_is_the_difference_of_the_last_tobacco_use_date_until_the_effective_date__Considering_the_number_of_months_since_last_tobacco_use_can_impact_the_rate_charged_by_a_plan_this_field_is_required_to_be_included_for_a_more_accurate_search_result__Age_CalculationEither_an_age_or_dob_value_must_be_provided___If_age_is_provided_that_value_is_used_in_determining_eligibility_and_premiums__If_a_dob_is_provided_a_more_accurate_age_is_calculated_using_the_combination_of_dob_the_effective_date_and_plan_specific_rating_age_adjustments___If_both_fields_are_populated_age_takes_precedence_and_no_calculation_will_occur_Plan_rates_can_have_age_adjustments_affecting_what_premiums_get_returned___Additionally_effective_date_in_relation_to_age_affects_premium_calculation_and_eligibility___Therefore_determining_the_correct_age_is_important_for_accurate_results__Cohabitationdoes_not_cohabitate_indicates_whether_the_person_is_living_with_the_household__Minimal_Essential_Coverage__MEChas_mec_indicates_whether_a_person_has_MedicaidCHIP_and_may_possibly_not_be_included_in_the_household_for_premium_determination_and_insurance_eligibility__Relationshiprelationship__which_is_not_required_to_issue_a_request__is_the_relationship_of_a_household_member_to_the_person_applying_for_health_insurance__For_the_main_enrollee_the_Self_relationship_is_used_Each_plan_on_the_marketplace_defines_a_set_of_dependent_relationships_within_a_household_as_eligible_to_enroll_in_that_plan_If_it_is_known_by_the_caller_what_relationships_exist_within_a_household_when_making_a_request_to_Marketplace_API_the_API_can_more_accurately_determine_household_eligibility_for_plans___If_the_relationship_field_is_used_in_a_request_it_must_be_a_valid_relationship_for_the_provided_market_year__see_list_below_When_a_household_request_is_sent_without_relationships_present_in_the_household_Marketplace_API_will_make_as_accurate_an_eligibility_determinaton_as_possible_without_the_relationship_values_The_total_set_of_dependent_relationships_that_plans_may_use_to_restrict_eligibility_may_change_over_the_years__For_2020_and_2021_the_possible_relationship_types_that_plans_may_utilize_are_as_follows2020_______________________________2021______________________________________________________________Self_____________________________SelfBrother_or_Sister________________Brother_or_SisterChild____________________________ChildCollateral_Dependent_____________Collateral_DependentEx_Spouse________________________Ex_SpouseFoster_Child_____________________Foster_ChildGrandson_or_Granddaughter________Grandson_or_GranddaughterLife_Partner_____________________Life_PartnerNephew_or_Niece__________________Nephew_or_NieceOther_Relationship_______________Other_RelationshipOther_Relative___________________Other_RelativeSponsored_Dependent______________Sponsored_DependentSpouse___________________________SpouseStepson_or_Stepdaughter__________Stepson_or_StepdaughterWard_____________________________WardAdopted_Child___________________Annultant_______________________Brother_in_Law_or_Sister_in_Law_Court_Appointed_Guardian________Dependent_of_a_Minor_Dependent__Guardian________________________Son_in_Law_or_Daughter_in_Law___Stepparent______________________As_can_be_seen_from_this_list_the_list_of_potential_relationships_has_been_simplified_between_2020_and_2021__When_a_relationship_is_not_one_of_the_obvious_choices_in_this_list_the_fallback_values_of_Other_Relative_and_Other_Relationship_may_be_used__UtilizationFinally_utilization_is_one_of_Low_Medium_High_and_is_a_description_of_how_much_a_person_intends_to_use_their_health_insurance__Understanding_ErrorsThe_Marketplace_API_returns_standard_HTTP_status_codes_which_indicate_whether_a_specific_HTTP_request_has_successfully_completed__For_some_errors_additional_information_is_provided_in_the_response_body_including_an_application_error_code_and_a_brief_message__HTTP_Response_Status_CodesResponses_are_grouped_in_five_classes____Successful_responses__200299____Client_errors__400499____Server_errors__500599_Marketplace_API_Error_CodesThe_various_codes_are_listed_below1000___errInternalServerError______The_Internal_Server_Error_response_code_indicates_that_the_server_encountered_an_unexpected_condition_that_prevented_it_from_fulfilling_the_request_______Request__GET_apiv1drugssearchq_______Response_________________code_1000________________status_500________________message_Internal_server_error________________error_sql_Scan_called_without_calling_Next______________1001___errCountyNotFound______This_error_code_is_returned_by_the__County_Lookup_by_FIPS_referencegeographycounty_lookup_by_fipsget_endpoint_when_no_county_is_found_using_the__FIPS_provided_in_the_request__For_example______Request___GET_apiv1counties35094____Response____________________code_1001__________________status_404__________________message_county_not_found__________________error_sql_No_records_found________________1002___errStateNotFound______This_error_code_is_returned_by_the__Lookup_State_referencegeographylookup_stateget_endpoint_when_no_state_is_found_using_the_state_provided_in_the_request__For_example______Request___GET_apiv1statesNP____Response____________________code_1002__________________status_404__________________message_state_not_found__________________error_sql_No_records_found________________1003___errInvalidInput_______This_error_code_is_returned_by_various_endpoints_when_the_required_input_is_invalid__The_message_provided_in_the_response_will_assist_in_resolving_the_problem_before_re_sending_the_request__For_example______Request___GET_apiv1issuers1019____Response______________________code_1003____________________status_400____________________message_invalid_issuers_request____________________error_invalid_issuer_ID_format________________1004___errIssuerNotFound_______This_error_code_is_returned_by_the__Get_Issuer_referenceinsurance_issuersget_issuerget_issuer_endpoint_when_no_issuer_is_found_using_the_issuer_id_provided_in_the_request__For_example______Request___GET_apiv1issuers01922____Response____________________code_1004__________________status_404__________________message_issuer_not_found__________________error_sql_No_records_found________________1005___errCrosswalkNotFound_______This_error_code_is_returned_by_the__Crosswalk_a_previous_year_plan_referenceinsurance_plansplan_crosswalkcrosswalk_a_previous_year_plan_endpoint_when_no_crosswalk_is_found_using_the_parameters_provided_in_the_request__For_example______Request___GET_apiv1crosswalkyear2018plan_id53882IL0040002stateIN_______________zipcode60647fips17031____Response____________________code_1005__________________status_404__________________message_No_crosswalk_found_for_those_parameters__________________error_sql_No_records_found________________1006___errPlanNotFound_______This_error_code_is_returned_by_various_endpoints_when_no_plan_is_found_using_the_parameters_provided_in_the_request__For_example______Request___GET_apiv1plans11512NC0100035____Response____________________code_1006__________________status_404__________________message_Plan_not_found__________________error_sql_No_records_found________________1007___errTimeout_______This_error_code_is_returned_by_various_endpoints_when_the_request_timed_out__For_example______Request___various_endpoints____Response____________________code_1007__________________status_500__________________message_request_timed_out_try_again__________________error_db_query_timed_out________________1008___errStateMedicaidNotFound_______This_error_code_is_returned_by_the__State_Medicaid_Data_referencegeographystate_medicaid_dataget_endpoint_when_no_medicaid_is_found_using_the_parameters_provided_in_the_request__For_example______Request___GET_apiv1statesNVmedicaid____Response____________________code_1008__________________status_404__________________message_state_medicaid_not_found__________________error_year_out_of_range________________1009___errPovertyGuidelineNotFound_______This_error_code_is_returned_by_the__State_Poverty_Guidelines_referencegeographystate_poverty_guidelinesget_endpoint_when_no_U_S__federal_poverty_guidelines_is_found_using_the_parameters_provided_in_the_request__For_example______Request___GET_apiv1statesXXpoverty_guidelines____Response____________________code_1009__________________status_400__________________message_poverty_guideline_not_found__________________error_sql_No_records_found________________1010___errPercentageFPLNotFound_______This_error_code_is_returned_by_the__Poverty_Level_Percentage_referencehouseholds__eligibilitypoverty_level_percentageget_endpoint_when_no_percentage_of_federal_poverty_level_is_found_using_the_parameters_provided_in_the_request__For_example______Request___GET_apiv1householdspcfplyear2021stateNVsize2income14000____Response____________________code_1010__________________status_404__________________message_percentage_of_federal_poverty_level_not_found__________________error_guideline_not_found_for_state_NV_year_2021________________1011___errQualityRatingNotFound_______This_error_code_is_returned_by_the__Quality_Ratings_referenceinsurance_plansquality_ratingsget_endpoint_when_there_are_no_quality_ratings_for_a_plan__For_example______Request___GET_apiv1plansXXXXXXXXXXXquality_ratingsyear2021____Response____________________code_1011__________________status_404__________________message_No_quality_rating_found_for_those_parameters__________________error_sql_No_records_found________________1012___errCoverageUnavailable_______This_error_code_is_returned_by_various_endpoints_when_the_coverage_data_is_temporarily_unavailable__For_example______Request___various_endpoints____Response____________________code_1012__________________status_503__________________message_coverage_data_temporarily_unavailable__________________error_coverage_database_unavailable________________1013___errProviderNotFound_______This_error_code_is_returned_by_various_Provider_related_endpoints_when_the_provider_is_not_found__For_example______Request___various_endpoints____Response____________________code_1013__________________status_404__________________message_provider_not_found__________________error_sql_No_records_found________________1014___errDrugNotFound_______This_error_code_is_returned_by_various_Drug_related_endpoints_when_the_drug_is_not_found__For_example______Request___various_endpoints____Response____________________code_1014__________________status_404__________________message_drug_not_found__________________error_sql_No_records_found________________1015___errMissingMedicaidCHIPEligibility_______This_error_code_is_returned_when_no_Medicaid_CHIP_Eligibility_plans_are_found_using_the_parameters_provided_in_the_request_______Request___POST_apiv1householdseligibilityestimates____Response____________________code_1015__________________status_404__________________message_missing_medicaid_eligibility_data__________________error_missing_eligibility_for_fiscal_year_YYYY_quarter_Q_state_SS________________1016___errTooFewPlans_______This_error_code_is_returned_when_there_are_not_enough_plans_in_a_given_service_area_to_compute_a_second_lowest_cost_silver_plan_for_an_example_the_errTooFewPlans_code_may_be_returned_______Request___POST_apiv1householdseligibilityestimates____Response____________________code_1016__________________status_404__________________message_not_enough_plans_to_calculate_SLCSPLCBP__________________error_not_enough_plans_to_calculate_SLCSPLCBP________________1017___errRateAreaNotFound_______This_error_code_is_returned_by_various_Drug_related_endpoints_when_the_rate_area_is_not_found__For_example______Request___GET_apiv1rate_areasstateINzipcode60647fips17031____Response____________________code_1017__________________status_404__________________message_rate_area_not_found__________________error_No_rate_area_could_be_determined_________________Marketplace_API_Common_Error_Codes400_Bad_Request___Client_supplied_invalid_or_incorrect_values_to_the_requested_end_point404_Not_Found___End_point_could_not_find_the_requested_object_s_Marketplace_API_Uncommon_Error_Codes500_Internal_Server_Error___An_unexpected_error_occurred503_Service_Unavailable___The_requested_service_is_temporarily_unavailable_try_again_later_",
  "license": "Unlicense",
  "main": "src/index.js",
  "scripts": {
    "test": "mocha --recursive"
  },
  "browser": {
    "fs": false
  },
  "dependencies": {
    "superagent": "3.7.0",
    "querystring": "0.2.0"
  },
  "devDependencies": {
    "mocha": "~2.3.4",
    "sinon": "1.17.3",
    "expect.js": "~0.3.1"
  }
}