Developer

About Getting Started

• What's your maintenance schedule?

  When the official lostark website goes down for maintenance, so does Lostark Open API website, including all API endpoints as well. Also please note that Lostark Open API services alone could be under maintenance whenever unfortunate, unexpected errors occur.

• API from API Documentations call succeeded, but It returns a 401 error.
  Make sure you 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.
  ※ Make sure you avoided bad examples below.

  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. URL is not required.

• How many clients can I create

  Up to 5 per an account

• I don't like some articles on the Terms of Use. Can I still go on creating a client?

  No you can't. You must agree to the Terms of Use and the Privacy Policy.

• Where is my JWT key

  Look for API KEY. You can find the key on your MY CLIENTS page or you can check the token on the popup by clicking the red identity button above on the right top corner.

• Why do you have throttling?

  To support developers better. Throttling can ensure fair usage, service stability, and good application design. You will get to come up with a better caching strategy to fetch in-game data on your client application because the number of requests is limited to a certain amount.

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

  "Try it out" will only populate input fields and the "Execute" button. You need to fill in those required parameters and click 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, choose one of your clients and click "REQUEST TO INCREASE LIMIT" button and start filling out the form.

• It looks like some of the in-game data are not real-time.

  It may take up a few minutes to sync up. Let us know if you still can't retrieve the latest, updated data after a half an hour.

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

  Please email us developer-lostark@smilegate.com and describe what you encountered as detailed as possible. Presenting a way to reproduce will be greatly appreciated.

• API requests stop working all of a sudden.

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

• My application keeps hitting the maximum limit

  You may need to check out the API request limit and the http response headers. If you see 0 value for 'X-RateLimit-Remaining' key, you may throttle your client application or adjust the request interval.

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

  Only application/json is allowed.