Authentication

API Key Authentication

Quickscope’s RPC access is secured using API keys. Every request to a private endpoint must include a valid API key associated with your project or Squad.

You can manage and generate keys directly from the Dashboard > API Keys section.


How It Works

  • API keys are unique to each project
  • Each key is tied to your account or Squad and can be rotated or revoked at any time
  • You must include your API key using the ?api-key query parameter for all RPC and WebSocket calls

Authentication Format

To authenticate an RPC request, include your API key using the ?api-key query parameter:

?api-key='yourapikey'

This applies to both HTTP and WebSocket endpoints.


Security Best Practices

  • Never expose your API key in frontend or public code
  • Rotate keys regularly if you're sharing access across teams
  • Use separate keys per environment (e.g. dev, staging, prod)
  • Revoke unused or compromised keys immediately from the dashboard