Rate limiting

When your app makes a call to the Web SDK, the call consumes resources.
Consumption is calculated in credits, and it depends on the type of operation, as well as on the type of board item that is the target of the request.

For example:

Drag and drop events don't use any credits.
Cost: 0 credits
Most calls use 50 credits per call.
Time-consuming operations such as creating or updating images and embed items are computationally more expensive than getting a sticky note; therefore, they consume more credits.
Cost: 500 credits per call

Within the enforced rate limits, it's possible to perform bulk actions (creating, updating or deleting multiple items at once).

Web SDK methods fall in one of the following rate limit weight levels:

Weight	Cost of one Web SDK API call	Action
Level 1	50 credits	Most actions on board items.
Level 2	100 credits	N/A
Level 3	500 credits	Create or update an image or an embed item.
Level 4	2000 credits	N/A

Current rate limits for the Miro Web SDK:

Limit	Credits	Note
Max. credits per minute	100,000	It supports: Creating 2000 board items a minute. Creating 200 image items a minute.
Max. credits per hour	1,000,000	It supports: Creating 20000 board items an hour. Creating 2000 image items an hour.

If your app exceeds either limit, it receives an error.
If your app exceeds a limit, it needs to wait for new credits before making calls to the Web SDK.
New credits are issued after the time interval when the limit was triggered has elapsed.

SDK APIs rate limits

API	Cost (credits per call)
`miro.board.createAppCard`	50
`miro.board.createCard`	50
`miro.board.createConnector`	50
`miro.board.createEmbed`	500
`miro.board.createFrame`	50
`miro.board.createImage`	500
`miro.board.createPreview`	50
`miro.board.createShape`	50
`miro.board.createStickyNote`	50
`miro.board.createTag`	50
`miro.board.createText`	50
`miro.board.getIdToken`	50
`miro.board.getInfo`	50
`miro.board.getUserInfo`	50
`miro.board.getOnlineUsers`	50
`miro.board.getAppData`	50
`miro.board.setAppData`	50
`miro.board.canUse`	50
`miro.board.goToLink`	50
`miro.board.getMetadata`	50
`miro.board.setMetadata`	50
`miro.board.bringToFront`	50
`miro.board.sendToBack`	50
`miro.board.bringInFrontOf`	50
`miro.board.sendBehindOf`	50
`miro.board.get`	500
`miro.board.getSelection`	500
`miro.board.select`	50
`miro.board.deselect`	50
`miro.board.remove`	50
`miro.board.group`	50
`miro.board.events.broadcast`	50
`miro.board.viewport.get`	50
`miro.board.viewport.set`	50
`miro.board.viewport.zoomTo`	50
`miro.board.viewport.setZoom`	50
`miro.board.viewport.getZoom`	50
`miro.board.collaboration.startSession`	50
`miro.board.collaboration.getSessions`	50
`session.end`	50
`session.invite`	50
`session.join`	50
`session.leave`	50
`session.hasJoined`	50
`miro.board.collaboration.attention.isFollowing`	50
`miro.board.collaboration.attention.getFollowedUser`	50
`miro.board.collaboration.attention.follow`	50
`miro.board.collaboration.attention.unfollow`	50
`miro.board.findEmptySpace`	50
`miro.board.timer.get`	50
`miro.board.timer.start`	50
`miro.board.timer.isStarted`	50
`miro.board.timer.prolong`	50
`miro.board.timer.stop`	50
`miro.board.timer.pause`	50
`miro.board.timer.resume`	50
`collection.set`	50
`collection.get`	50
`collection.remove`	50
`miro.board.experimental.createMindmapNode`	50 * (1 + num_of_children)
`miro.board.experimental.action.register`	50
`miro.board.experimental.action.deregister`	50
`miro.board.experimental.get`	500
`miro.board.experimental.getSelection`	500
`miro.board.experimental.select`	50
`miro.board.experimental.deselect`	50
`miro.board.experimental.remove`	50

Items methods rate limits

Note: Item refers to most of supported item types on a board. See supported board items for more details.

Method	Cost (credits per call)
`item.sync`	50
`embed.sync`	500
`image.sync`	500
`item.goToLink`	50
`item.getMetadata`	50
`item.setMetadata`	50
`item.bringToFront`	50
`item.sendToBack`	50
`item.bringInFrontOf`	50
`item.sendBehindOf`	50
`item.getConnectors`	500
`mindmapNode.getChildren`	500
`image.getFile`	50
`image.getDataUrl`	50
`group.ungroup`	50
`group.getItems`	50