MarketplaceApi.HouseholdsEligibilityApi

All URIs are relative to https://marketplace.api.healthcare.gov/api/v1

Method	HTTP request	Description
householdsEligibilityEstimatesPost	POST /households/eligibility/estimates
householdsIchraPost	POST /households/ichra	Get affordability and premium of the lowest cost silver plan
householdsLcbpPost	POST /households/lcbp	Get lowest cost bronze plan for a household
householdsLcspPost	POST /households/lcsp	Get lowest cost silver plan
householdsPcfplGet	GET /households/pcfpl
householdsSlcspPost	POST /households/slcsp	Get second lowest cost silver plan

householdsEligibilityEstimatesPost

InlineResponse2005 householdsEligibilityEstimatesPost(apikeyestimate, opts)

Note Use this JSON example in the POST Body in the request pane to view results: `{ \"household\": { \"income\": 52000, \"people\": [ { \"dob\": \"1992-01-01\", \"aptc_eligible\": true, \"gender\": \"Female\", \"uses_tobacco\": false } ] }, \"market\": \"Individual\", \"place\": { \"countyfips\": \"37057\", \"state\": \"NC\", \"zipcode\": \"27360\" }, \"year\": 2019 }` Create an eligibility estimate for a household. Index of each object in response array is index into Household.people array: i.e., that eligibility estimate is for that person

Example

var MarketplaceApi = require('marketplace_api');
var defaultClient = MarketplaceApi.ApiClient.instance;

// Configure API key authorization: API Key
var API Key = defaultClient.authentications['API Key'];
API Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API Key.apiKeyPrefix = 'Token';

var apiInstance = new MarketplaceApi.HouseholdsEligibilityApi();

var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication

var estimate = new MarketplaceApi.Estimate(); // Estimate | eligibility estimate request object

var opts = { 
  'year': 2019, // Number | 4 digit market year (Defaults to the current year when not specified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.householdsEligibilityEstimatesPost(apikeyestimate, opts, callback);

Parameters

Name	Type	Description	Notes
apikey	String	API key used for authentication
estimate	Estimate	eligibility estimate request object
year	Number	4 digit market year (Defaults to the current year when not specified).	[optional]

Return type

InlineResponse2005

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: Not defined
Accept: application/json

householdsIchraPost

ICHRAResponse householdsIchraPost(apikeyichra, opts)

Get affordability and premium of the lowest cost silver plan

Note Use this JSON example in the POST Body in the request pane to view results: `{ \"household\": { \"income\": 52000, \"people\": [ { \"dob\": \"1992-01-01\", \"aptc_eligible\": true, \"gender\": \"Female\", \"uses_tobacco\": false } ] }, \"market\": \"Individual\", \"place\": { \"countyfips\": \"37057\", \"state\": \"NC\", \"zipcode\": \"27360\" }, \"hra\": 500, \"year\": 2020 }` Get the lowest cost silver plan for a household and ICHRA affordability. Response is determination of affordability and lowest cost silver plan premium set to the rate for the household.

Example

var MarketplaceApi = require('marketplace_api');
var defaultClient = MarketplaceApi.ApiClient.instance;

// Configure API key authorization: API Key
var API Key = defaultClient.authentications['API Key'];
API Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API Key.apiKeyPrefix = 'Token';

var apiInstance = new MarketplaceApi.HouseholdsEligibilityApi();

var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication

var ichra = new MarketplaceApi.Ichra(); // Ichra | ichra request object

var opts = { 
  'year': 2019, // Number | 4 digit market year (Defaults to the current year when not specified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.householdsIchraPost(apikeyichra, opts, callback);

Parameters

Name	Type	Description	Notes
apikey	String	API key used for authentication
ichra	Ichra	ichra request object
year	Number	4 digit market year (Defaults to the current year when not specified).	[optional]

Return type

ICHRAResponse

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: Not defined
Accept: application/json

householdsLcbpPost

LowestCostPlanResponse householdsLcbpPost(apikeylcbp, opts)

Get lowest cost bronze plan for a household

Note Use this JSON example in the POST Body in the request pane to view results: `{ \"household\": { \"income\": 52000, \"people\": [ { \"dob\": \"1992-01-01\", \"aptc_eligible\": true, \"gender\": \"Female\", \"uses_tobacco\": false } ] }, \"market\": \"Individual\", \"place\": { \"countyfips\": \"37057\", \"state\": \"NC\", \"zipcode\": \"27360\" }, \"year\": 2020 }` Get the lowest cost bronze plan for a household. Response is a plan object with the premium set to the rate for the household.

Example

var MarketplaceApi = require('marketplace_api');
var defaultClient = MarketplaceApi.ApiClient.instance;

// Configure API key authorization: API Key
var API Key = defaultClient.authentications['API Key'];
API Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API Key.apiKeyPrefix = 'Token';

var apiInstance = new MarketplaceApi.HouseholdsEligibilityApi();

var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication

var lcbp = new MarketplaceApi.Lcbp(); // Lcbp | lcbp request object

var opts = { 
  'year': 2019, // Number | 4 digit market year (Defaults to the current year when not specified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.householdsLcbpPost(apikeylcbp, opts, callback);

Parameters

Name	Type	Description	Notes
apikey	String	API key used for authentication
lcbp	Lcbp	lcbp request object
year	Number	4 digit market year (Defaults to the current year when not specified).	[optional]

Return type

LowestCostPlanResponse

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: Not defined
Accept: application/json

householdsLcspPost

LowestCostPlanResponse householdsLcspPost(apikeylcsp, opts)

Get lowest cost silver plan

Note Use this JSON example in the POST Body in the request pane to view results: `{ \"household\": { \"income\": 52000, \"people\": [ { \"dob\": \"1992-01-01\", \"aptc_eligible\": true, \"gender\": \"Female\", \"uses_tobacco\": false } ] }, \"market\": \"Individual\", \"place\": { \"countyfips\": \"37057\", \"state\": \"NC\", \"zipcode\": \"27360\" }, \"year\": 2020 }` Get the lowest cost silver plan for a household. Response is a plan object with the premium set to the rate for the household. Note -- when calculating the LCSP for a household that has members in different rating areas, the household must be split by rating area and multiple LCSP requests must be sent, with the results summed at the end (applies only to 2019 ratings).

Example

var MarketplaceApi = require('marketplace_api');
var defaultClient = MarketplaceApi.ApiClient.instance;

// Configure API key authorization: API Key
var API Key = defaultClient.authentications['API Key'];
API Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API Key.apiKeyPrefix = 'Token';

var apiInstance = new MarketplaceApi.HouseholdsEligibilityApi();

var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication

var lcsp = new MarketplaceApi.Lcsp(); // Lcsp | lcsp request object

var opts = { 
  'year': 2019, // Number | 4 digit market year (Defaults to the current year when not specified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.householdsLcspPost(apikeylcsp, opts, callback);

Parameters

Name	Type	Description	Notes
apikey	String	API key used for authentication
lcsp	Lcsp	lcsp request object
year	Number	4 digit market year (Defaults to the current year when not specified).	[optional]

Return type

LowestCostPlanResponse

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: Not defined
Accept: application/json

householdsPcfplGet

InlineResponse2006 householdsPcfplGet(apikeyyearstate, size, income)

Household income as a percentage of the federal poverty level

Example

var MarketplaceApi = require('marketplace_api');
var defaultClient = MarketplaceApi.ApiClient.instance;

// Configure API key authorization: API Key
var API Key = defaultClient.authentications['API Key'];
API Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API Key.apiKeyPrefix = 'Token';

var apiInstance = new MarketplaceApi.HouseholdsEligibilityApi();

var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication

var year = 2019; // Number | 4 digit market year.

var state = "VA"; // String | 2-letter USPS state abbreviation, uppercased.

var size = 5; // Number | Total size of household

var income = 40000; // Number | Household Income


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.householdsPcfplGet(apikeyyearstate, size, income, callback);

Parameters

Name	Type	Description
apikey	String	API key used for authentication
year	Number	4 digit market year.
state	String	2-letter USPS state abbreviation, uppercased.
size	Number	Total size of household
income	Number	Household Income

Return type

InlineResponse2006

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: Not defined
Accept: application/json

householdsSlcspPost

LowestCostPlanResponse householdsSlcspPost(apikeyslcsp, opts)

Get second lowest cost silver plan

Note Use this JSON example in the POST Body in the request pane to view results: `{ \"household\": { \"income\": 52000, \"people\": [ { \"dob\": \"1992-01-01\", \"aptc_eligible\": true, \"gender\": \"Female\", \"uses_tobacco\": false } ] }, \"market\": \"Individual\", \"place\": { \"countyfips\": \"37057\", \"state\": \"NC\", \"zipcode\": \"27360\" }, \"year\": 2020 }` Get the second lowest cost silver plan for a household. Response is a plan object with the premium set to the rate for the household. Note -- when calculating the SLCSP for a household that has members in different rating areas, the household must be split by rating area and multiple SLCSP requests must be sent, with the results summed at the end (applies only to 2019 ratings).

Example

var MarketplaceApi = require('marketplace_api');
var defaultClient = MarketplaceApi.ApiClient.instance;

// Configure API key authorization: API Key
var API Key = defaultClient.authentications['API Key'];
API Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API Key.apiKeyPrefix = 'Token';

var apiInstance = new MarketplaceApi.HouseholdsEligibilityApi();

var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication

var slcsp = new MarketplaceApi.Slcsp(); // Slcsp | slcsp request object

var opts = { 
  'year': 2019, // Number | 4 digit market year (Defaults to the current year when not specified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.householdsSlcspPost(apikeyslcsp, opts, callback);

Parameters

Name	Type	Description	Notes
apikey	String	API key used for authentication
slcsp	Slcsp	slcsp request object
year	Number	4 digit market year (Defaults to the current year when not specified).	[optional]

Return type

LowestCostPlanResponse

Authorization

[API Key](../README.md#API Key)

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

HouseholdsEligibilityApi.md

Latest commit

History

HouseholdsEligibilityApi.md

File metadata and controls

MarketplaceApi.HouseholdsEligibilityApi

householdsEligibilityEstimatesPost

Example

Parameters

Return type

Authorization

HTTP request headers

householdsIchraPost

Example

Parameters

Return type

Authorization

HTTP request headers

householdsLcbpPost

Example

Parameters

Return type

Authorization

HTTP request headers

householdsLcspPost

Example

Parameters

Return type

Authorization

HTTP request headers

householdsPcfplGet

Example

Parameters

Return type

Authorization

HTTP request headers

householdsSlcspPost

Example

Parameters

Return type

Authorization

HTTP request headers