Skip to main content

API Use Guidelines & Information

Usage Recommendations

  • Identify your service with a custom user agent.
  • Only send requests via your backend. Don't use the browser as a client.
  • Avoid sending multiple requests per minute to any endpoint.
  • Try to only send requests when needed. Don't bombard the API if nobody's on your site.

CORS Configuration

The SMPOnline API is not intended to be directly contacted by any end user's web browser. Please respect the CORS configuration and only contact the SMPOnline API via your backend services, ideally caching the results.

Result Caching

Any result you receive from SMP is continuously cached every 60 seconds with the current, new state of the server. Sending requests to check the state of things more often than this is excessive and may result in your IP or User Agent being blocked. 

Abuse

Any form of abuse of the API will result in a permanent ban from SMPOnline and other CMC Services. Please report any issues to Loki before degrading anyone else's experience.