Skip to main content
placeanalyzerAPI ReferenceGuías

Authentication

To use the Place Analyzer API, you need an

API Key that identifies you as an authorized client.

Get your API Key

  1. Access the Dashboard: Log in to your customer panel at dash.place-api.com
  2. Go to API Keys: Look for the "API Keys" or "Credentials" section
  3. Generate a new key: Create a new API Key for your project
  4. Save the key: The API Key is only shown once, make sure to save it in a secure place

Use the API Key

Send your API Key in the X-API-KEY header for all requests:

curl -X GET "https://api.place-api.com/valuation/v1/valuation-request/VAL-2025-001234" \
-H "X-API-KEY: your_api_key_here" \
-H "Content-Type: application/json"

Authentication Errors

If your API Key is invalid or missing, you will receive a 401 Unauthorized error:

{
"code": 401,
"status": "error",
"errorCode": "INVALID_API_KEY",
"message": "The provided API Key is invalid or has expired",
"timestamp": "2025-10-23T14:30:00Z",
"path": "/v1/valuation-request/VAL-2025-001234"
}

Common causes:

  • Incorrect API Key: Verify that you copied the key correctly
  • Expired API Key: Some keys have an expiration date
  • Incorrect format: Make sure to include the header as X-API-KEY: YOUR_API_KEY
  • Missing header: Don't forget to include the authentication header in each request

Available Environments

  • Valuation API: https://api.place-api.com/valuation/v1
  • Report API: https://api.place-api.com/report/v1

Best Practices

1. Use Environment Variables

Store your API Key in environment variables according to your platform:

# .env file (Node.js with dotenv)
PLACE_ANALYZER_API_KEY=your_api_key_here
PLACE_ANALYZER_VALUATION_URL=https://api.place-api.com/valuation/v1
PLACE_ANALYZER_REPORT_URL=https://api.place-api.com/report/v1

# Don't forget to add .env to your .gitignore
# .gitignore
.env
.env.local

2. Other Recommendations

  • Regular rotation: Change your API Key periodically for security
  • Monitor usage: Check the dashboard to see your API consumption
  • Revoke compromised keys: If you suspect your key was exposed, revoke it immediately
  • Use different keys: Create separate keys for development, staging, and production

Having trouble with authentication? Check our error handling guide.