Gets a list of the physical store locations sorted by the shortest distance to the coordinates sent. Partners are expected to display these locations on a map for the user to select which location to buy or sell from

Current providers are GREENDOT(buy) and ALLPOINT(sell)

📘

Cash purchases are only available at retail locations within the same U.S. state as the user’s verified KYC address. We’re actively working to expand cross-state availability over time

Sample API Request: POST

URL: https://caas-staging.coinme.com/services/locations/v2/query
headers:
"Authorization":"asdfghj", //authorization token, required,
'User-Agent: partnerapi' //required
Request Body
{
  "latitude": 38.49584, // Latitude of the user's location for searching nearby locations
  "longitude": -121.508401, // Longitude of the user's location for searching nearby locations
  "radius": 5.0, // Search radius in specified units (miles/kilometers, defaults to miles) 
  "limit":3, // Maximum number of location results to return
  "providers": ["greendot"] // Array of provider names to filter results
}

Sample API Response:

{
  "data": {
    "providers": [
      "GREENDOT"
    ],
    "locations": [
      {
        "id": "CVS9823", // Unique identifier for the location
        "locationReference": "R1JFRU5ET1QtMjQzNDpsYXQ9MzguNDk1MTMzLGxuZz0tMTIxLjUwNTMzNg==", // Encoded reference of the location
        "provider": "GREENDOT", // Provider name
        "country": "USA", // Country where the location is situated
        "state": "CA", // State where the location is situated
        "city": "Sacramento", // City where the location is situated
        "address": "1350 Florin Rd", // Address of the location
        "zipCode": "95822", // ZIP code of the location
        "hours": null, // Operating hours of the location
        "sellAllowed": false, // Indicates if selling is allowed at this location
        "buyAllowed": true, // Indicates if buying is allowed at this location
        "imageUrl": null, // URL of the location image
        "googlePlacesLink": null, // Google Places link for the location
        "notes": null, // Additional notes about the location
        "description": "CVS", // Description of the location
        "coordinates": {
          "latitude": 38.495133, // Latitude of the location
          "longitude": -121.505336 // Longitude of the location
        },
        "lineOfSightDistance": 0.1727927078581357, // Distance from the reference point
        "lineOfSightMetric": "mi", // Measurement unit for the distance
        "supportedCoins": ["BTC", "ETH", "USDC"], // List of supported coins at this location
        "locationFees": null, // Fees associated with the location
        "metadata": {
          "providerLocationReference": "2434", // Reference ID of the provider location
          "phone": "9163925184" // Phone number of the location
        }
      },
      {
        "id": "Rite Aid6084",
        "locationReference": "R1JFRU5ET1QtMjQ2MTpsYXQ9MzguNDkzNTEzLGxuZz0tMTIxLjUyMjU2MQ==",
        "provider": "GREENDOT",
        "country": "USA",
        "state": "CA",
        "city": "Sacramento",
        "address": "980 Florin Rd",
        "zipCode": "95831",
        "hours": null,
        "sellAllowed": false,
        "buyAllowed": true,
        "imageUrl": null,
        "googlePlacesLink": null,
        "notes": null,
        "description": "Rite Aid",
        "coordinates": {
          "latitude": 38.493513,
          "longitude": -121.522561
        },
        "lineOfSightDistance": 0.7824274400825684,
        "lineOfSightMetric": "mi",
        "supportedCoins": ["BTC", "ETH", "USDC"],
        "locationFees": null,
        "metadata": {
          "providerLocationReference": "2461",
          "phone": "9164227202"
        }
      }
    ]
  },
  "errorResponse": null
}

Error Codes