Developer

About Getting Started

• What's your maintenance schedule?

  When the official Lostark website undergoes maintenance, the Lostark Open API website and all its endpoints will also be unavailable. Additionally, the Lostark Open API services may undergo maintenance due to unexpected errors.

• Why did my API call from the API Documentations succeed but return a 401 error.
  Ensure you have set a valid Access Token (JWT) value in the Authorize popup input.
  ex) bearer your_JWT
  
  ※ Even if the token is correct, token validation will fail if the leading 'bearer' string is missing.
  ※ Avoid the following invalid examples:

  Example	Validity
  "Authorization: bearer abcdefghijklmnopqrstuvwxyz"	O => VALID
  "Authorization: abcdefghijklmnopqrstuvwxyz"	X => INVALID (missing "bearer")
  "Authorization: bearer {abcdefghijklmnopqrstuvwxyz}"	X => INVALID
  "Authorization: bearer <abcdefghijklmnopqrstuvwxyz>"	X => INVALID
  "Authorization: bearer{abcdefghijklmnopqrstuvwxyz}"	X => INVALID
  "Authorization: bearerabcdefghijklmnopqrstuvwxyz"	X => INVALID

• I do not have a URL for my client application. Can I still create a client?

  Yes, you can. A URL is not required.

• How many clients can I create?

  You can create up to 5 clients per account.

• I don't agree with some articles in the Terms of Use. Can I still create a client?

  No, you must agree to the Terms of Use and the Privacy Policy to create a client.

• Where can I find my JWT key?

  Look for the API KEY on your MY CLIENTS page or check the token in the popup by clicking the red identity button at the top right corner.

• Why do you have throttling?

  Throttling promotes fair usage, enhances service stability, and fosters robust application design. It encourages the development of effective caching strategies for retrieving in-game data, leveraging limited request capabilities.

• [Try it out] button doesn't make any request in API Documentation

  The "Try it out" button populates the input fields and activates the "Execute" button. Fill in the required parameters and click the Execute button to make an actual HTTP call.

About Usage

• I want to increase my API request limit. What can I do?

  Please go to MY CLIENTS, select one of your clients, click "REQUEST TO INCREASE LIMIT" button, and fill out the form.

• It seems some in-game data is not real-time.

  If data synchronization takes a few minutes, please allow for this delay. If you are unable to retrieve the latest data after half an hour, please inform us.

• I discovered some bugs in the APIs. Is there a way to report that?

  Please email us at developer-lostark@smilegate.com and describe the issue in detail. Providing steps to reproduce the bug is greatly appreciated.

• API requests stop working all of a sudden.

  Please check:
  1. your JWT token.
  2. the authorization header and bearer input.
  3. the http status code you received.
  4. API Status on our website.
  5. the response header and the throttling details

• My application keeps hitting the maximum limit

  Check the API request limit and the HTTP response headers. If you see a 0 value for the 'X-RateLimit-Remaining' key, throttle your client application or adjust the request interval.

• Do you also offer XML content type for the responses?

  No, only application/json is allowed.