GET api/PharmacyLocator?zipCode={zipCode}&maxDistance={maxDistance}&bin={bin}&groupCode={groupCode}
Retrieves a list of pharmacies within a specified distance from a given zip code.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| zipCode |
The zip code used as the center point for locating pharmacies. |
string |
Required |
| maxDistance |
The maximum distance (in miles) from the zip code within which to search for pharmacies. This parameter is optional. Its default value is 10 and its maximum is 100. |
integer |
Default value is 10 |
| bin |
The BIN used for filtering pharmacies. This parameter is optional if both `bin` and `groupCode` are not provided. If either `bin` or `groupCode` is provided, both are required. |
string |
None. |
| groupCode |
The group code used for filtering pharmacies. This parameter is optional if both `bin` and `groupCode` are not provided. If either `bin` or `groupCode` is provided, both are required. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Returns a list of the closest 100 pharmacies located within the specified distance of the provided zip code.
Collection of PharmacyLocatorResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| NPI | string |
None. |
|
| LocationName |
The name of the pharmacy |
string |
None. |
| StreetAddress |
The address of the pharmacy |
string |
None. |
| City |
The city of the pharmacy |
string |
None. |
| StateCode |
The state of the pharmacy |
string |
None. |
| ZipCode |
The zip code of the pharmacy |
string |
None. |
| PhoneNumber |
The phone number of the pharmacy |
string |
None. |
| PhoneExt |
The phone number extension of the pharmacy |
string |
None. |
| PhoneNumberFull |
The full phone number of the pharmacy |
string |
None. |
| Distance |
The distancy of the pharmacy from the zip code entered |
decimal number |
None. |
| Latitude |
The latitude of the pharmacy |
decimal number |
None. |
| Longitude |
The longitude of the pharmacy |
decimal number |
None. |
Response Formats
application/json, text/json, application/json-patch+json
[
{
"npi": "sample string 2",
"locationName": "sample string 3",
"streetAddress": "sample string 4",
"city": "sample string 5",
"stateCode": "sample string 6",
"zipCode": "sample string 7",
"phoneNumber": "sample string 8",
"phoneExt": "sample string 9",
"phoneNumberFull": "sample string 10",
"distance": 11.0,
"latitude": 1.0,
"longitude": 1.0
},
{
"npi": "sample string 2",
"locationName": "sample string 3",
"streetAddress": "sample string 4",
"city": "sample string 5",
"stateCode": "sample string 6",
"zipCode": "sample string 7",
"phoneNumber": "sample string 8",
"phoneExt": "sample string 9",
"phoneNumberFull": "sample string 10",
"distance": 11.0,
"latitude": 1.0,
"longitude": 1.0
}
]