All URIs are relative to https://marketplace.api.healthcare.gov/api/v1
Method | HTTP request | Description |
---|---|---|
coverageSearchGet | GET /coverage/search | Search providers |
coverageStatsGet | GET /coverage/stats | Coverage statistics |
drugsAutocompleteGet | GET /drugs/autocomplete | Autocomplete drugs by name |
drugsCoveredGet | GET /drugs/covered | Get a list of whether drugs are covered by plans |
drugsSearchGet | GET /drugs/search | Search prescription drugs |
providersAutocompleteGet | GET /providers/autocomplete | Autocomplete nearby providers |
providersCoveredGet | GET /providers/covered | Get a list of whether a set of providers are covered by given plans |
providersSearchGet | GET /providers/search | Search providers |
InlineResponse20016 coverageSearchGet(apikeyq, zipcode)
Search providers
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.ProviderDrugCoverageApi();
var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication
var q = "hospital"; // String | search query
var zipcode = "19123"; // String | User's ZIP Code for searching nearby
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.coverageSearchGet(apikeyq, zipcode, callback);
Name | Type | Description | Notes |
---|---|---|---|
apikey | String | API key used for authentication | |
q | String | search query | |
zipcode | String | User's ZIP Code for searching nearby |
[API Key](../README.md#API Key)
- Content-Type: Not defined
- Accept: application/json
InlineResponse20015 coverageStatsGet(apikey)
Coverage statistics
Return statistics related to the number of coverage (drugs and providers) records.
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.ProviderDrugCoverageApi();
var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.coverageStatsGet(apikey, callback);
Name | Type | Description | Notes |
---|---|---|---|
apikey | String | API key used for authentication |
[API Key](../README.md#API Key)
- Content-Type: Not defined
- Accept: application/json
InlineResponse2002 drugsAutocompleteGet(apikeyq, opts)
Autocomplete drugs by name
Search prescription drugs
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.ProviderDrugCoverageApi();
var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication
var q = "ibuprof"; // String | name of drug to search for (minimum 3 chars)
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.drugsAutocompleteGet(apikeyq, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
apikey | String | API key used for authentication | |
q | String | name of drug to search for (minimum 3 chars) | |
year | Number | 4 digit market year (Defaults to the current year when not specified). | [optional] |
[API Key](../README.md#API Key)
- Content-Type: Not defined
- Accept: application/json
InlineResponse2004 drugsCoveredGet(apikeydrugs, planids, opts)
Get a list of whether drugs are covered by plans
Get a list of whether drugs are covered by plans
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.ProviderDrugCoverageApi();
var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication
var drugs = "1049589"; // String | array of drug RxCUIs
var planids = "11512NC0100031"; // String | array of plan IDs
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.drugsCoveredGet(apikeydrugs, planids, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
apikey | String | API key used for authentication | |
drugs | String | array of drug RxCUIs | |
planids | String | array of plan IDs | |
year | Number | 4 digit market year (Defaults to the current year when not specified). | [optional] |
[API Key](../README.md#API Key)
- Content-Type: Not defined
- Accept: application/json
InlineResponse2003 drugsSearchGet(apikeyq, opts)
Search prescription drugs
Search prescription drugs
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.ProviderDrugCoverageApi();
var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication
var q = "ibuprofen"; // String | name of drug to search for
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.drugsSearchGet(apikeyq, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
apikey | String | API key used for authentication | |
q | String | name of drug to search for | |
year | Number | 4 digit market year (Defaults to the current year when not specified). | [optional] |
[API Key](../README.md#API Key)
- Content-Type: Not defined
- Accept: application/json
Object providersAutocompleteGet(apikeyq, zipcode, type)
Autocomplete nearby providers
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.ProviderDrugCoverageApi();
var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication
var q = "hospital"; // String | search query (minimum 3 characters)
var zipcode = "19123"; // String | 5-digit US zipcode
var type = "Facility"; // String | Provider type, comma separated to specify multiple
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.providersAutocompleteGet(apikeyq, zipcode, type, callback);
Name | Type | Description | Notes |
---|---|---|---|
apikey | String | API key used for authentication | |
q | String | search query (minimum 3 characters) | |
zipcode | String | 5-digit US zipcode | |
type | String | Provider type, comma separated to specify multiple |
Object
[API Key](../README.md#API Key)
- Content-Type: Not defined
- Accept: application/json
InlineResponse20018 providersCoveredGet(apikeyproviderids, planids, opts)
Get a list of whether a set of providers are covered by given plans
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.ProviderDrugCoverageApi();
var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication
var providerids = "1407884893"; // String | array of provider NPIs
var planids = "83761GA0040002"; // String | array of plan IDs
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.providersCoveredGet(apikeyproviderids, planids, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
apikey | String | API key used for authentication | |
providerids | String | array of provider NPIs | |
planids | String | array of plan IDs | |
year | Number | 4 digit market year (Defaults to the current year when not specified). | [optional] |
[API Key](../README.md#API Key)
- Content-Type: Not defined
- Accept: application/json
InlineResponse20017 providersSearchGet(apikeyq, zipcode, type, opts)
Search providers
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.ProviderDrugCoverageApi();
var apikey = "d687412e7b53146b2631dc01974ad0a4"; // String | API key used for authentication
var q = "hospital"; // String | search query
var zipcode = "19123"; // String | User's ZIP Code for searching nearby
var type = "Facility"; // String | Provider type, comma separated to specify multiple
var opts = {
'year': 2019, // Number | 4 digit market year (Defaults to the current year when not specified).
'specialty': "specialty_example" // String |
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.providersSearchGet(apikeyq, zipcode, type, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
apikey | String | API key used for authentication | |
q | String | search query | |
zipcode | String | User's ZIP Code for searching nearby | |
type | String | Provider type, comma separated to specify multiple | |
year | Number | 4 digit market year (Defaults to the current year when not specified). | [optional] |
specialty | String | [optional] |
[API Key](../README.md#API Key)
- Content-Type: Not defined
- Accept: application/json