Rate limit header naming issue

API Issues
1

The rate limit header names returned by https://api.companieshouse.gov.uk/… URI’s are:

  • X-Ratelimit-Limit
  • X-Ratelimit-Remain
  • X-Ratelimit-Reset

Those returned by https://document-api.companieshouse.gov.uk are:

  • X-Ratelimit-Limit
  • X-Ratelimit-Remaining
  • X-Ratelimit-Reset

For consistency please use either X-Ratelimit-Remain or X-Ratelimit-Remaining and stick with it as this particular header is important for keeping track of usage. Thanks.

1 Like
2

Thank you for reporting the bug.
It should be …-Remaining

Will look at having that corrected for the next release.

3

Was this bug ever fixed? We are still seeing X-Ratelimit-Remain headers in https://api.companieshouse.gov.uk calls.

Furthermore we’ve noticed that https://document-api.companieshouse.gov.uk calls contain the following X-Ratelimit-* headers but not an X-Ratelimit-Window header:

  • X-Ratelimit-Limit
  • X-Ratelimit-Remaining
  • X-Ratelimit-Reset

Should the X-Ratelimit-Window header be included https://document-api.companieshouse.gov.uk calls since they contain the other rate limit headers?