HackMD API Policy

Last updated: February 11, 2022.

The polices listed below serve as a guideline for using HackMD API. They are incorporated in our terms of service.

Do not abuse the data

You may not use the APIs in any way to:

• scrape HackMD Data;
• use HackMD Data for any purpose other than as necessary for your application;
• keep Data any longer than the operation of your applications need.

Do not abuse the contents

• provide or direct inappropriate contents to children under the legal age of digital consent;
• promote pornography contents or solicit sex services.

Do not abuse the platform

You will:

• require your end users to comply with applicable law and the HackMD Terms of Service;
• only access (or attempt to access) an API as we described in the documentation.

You will not:

• remove, obscure, or alter HackMD's Terms of Service;
• permit or allow any third party to violate HackMD's Terms of Service or this policy.

API limits

There is a quota of 2000 calls per month and the rate limit is 100 calls every 5 minutes.

Upgrade to Prime plan to get 10,000 calls per month. The rate limit is 100 calls every 5 minutes.

API feature in beta

As HackMD API is in beta, these limits can alter without further warning. You may check your usage in 【API setting】

Rate Limit Headers

We have set some headers to help you track rate limits. These headers are:

• X-RateLimit-UserLimit: The total number of API calls allowed in the current rate limit window.
• X-RateLimit-UserRemaining: The number of API calls remaining in the current rate limit window.
• X-RateLimit-UserReset: The time when the current rate limit window resets, in Unix timestamp format.

These headers are included in API responses to help you monitor your usage and avoid exceeding the limits.