{"_id":"55fa3a948065a10d004e5bd5","parentDoc":null,"user":"54e4044e8ef7552300409dcb","version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":10,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["55fa37ca8065a10d004e5bb7","55fa37ca8065a10d004e5bb8","55fa37ca8065a10d004e5bb9","55fa37ca8065a10d004e5bba","55fca6bf34ae7c0d00ab8ea0","55ff80fd9e7ccf0d000a1d93","560220af7435de0d00fabd0d","56107f21bb9d920d00303e70","563e184077681a0d00d96a02","56fafc6596ec7e0e002ac85f","5915e54f7c2c552d008b8549","59499fcd64b5f5002690bbc1","59c451b7772699001c0f1df1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"__v":10,"category":{"_id":"55fa37ca8065a10d004e5bb7","__v":7,"project":"54e405191e51932d006abc39","version":"55fa37c88065a10d004e5bb6","pages":["55fa37ca8065a10d004e5bbb","55fa37ca8065a10d004e5bbc","55fa37ca8065a10d004e5bbd","55fa37ca8065a10d004e5bbe","55fa37ca8065a10d004e5bbf","55fa37ca8065a10d004e5bc0","55fa3a948065a10d004e5bd5","55fa3c3ba663c00d00773dce","55fa4b8eaba81f0d00a115e4","56733ae758c4890d00bb548a","56734f9c4b2a680d00524e09","569d8eae3dbdc20d005feee8"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-18T03:20:58.779Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"project":"54e405191e51932d006abc39","updates":["56071f7b44789e0d0071211a","58d18b9c175dc22500e32882"],"next":{"pages":[],"description":""},"createdAt":"2015-09-17T03:59:16.458Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Following is a map of the entire API including all of the API calls that are supported and what you can do with each call.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"HTTP Verb\",\n    \"h-1\": \"URL\",\n    \"h-2\": \"Functionality\",\n    \"h-3\": \"Rate Limits (per min)\",\n    \"2-0\": \"GET\",\n    \"2-1\": \"/users\",\n    \"2-2\": \"View all users created with your client keys (paginated).\",\n    \"2-3\": \"100\",\n    \"3-1\": \"/users\",\n    \"3-0\": \"POST\",\n    \"3-2\": \"Allows you to register a new user.\",\n    \"3-3\": \"100\",\n    \"4-0\": \"GET\",\n    \"4-1\": \"/users/<user:id>\",\n    \"4-2\": \"View user info and `refresh_token`.\",\n    \"4-3\": \"30\",\n    \"5-0\": \"PATCH\",\n    \"5-1\": \"/users/<user:id>\",\n    \"5-2\": \"Add/update KYC, log in credentials, profile, etc.\",\n    \"5-3\": \"30\",\n    \"6-0\": \"GET\",\n    \"6-1\": \"/users/<user:id>/nodes\",\n    \"6-2\": \"View all nodes linked to a user (paginated).\",\n    \"6-3\": \"100\",\n    \"7-0\": \"POST\",\n    \"7-1\": \"/users/<user:id>/nodes\",\n    \"7-2\": \"Allows you to create a deposit account or link an external bank account to a user.\",\n    \"8-0\": \"GET\",\n    \"8-1\": \"/users/<user:id>/nodes/<node:id>\",\n    \"8-2\": \"View node info.\",\n    \"9-0\": \"PATCH\",\n    \"9-1\": \"/users/<user:id>/nodes/<node:id>\",\n    \"9-2\": \"Update `supp_id`, verify micro-deposits, etc.\",\n    \"10-1\": \"/users/<user:id>/nodes/<node:id>\",\n    \"10-0\": \"DELETE\",\n    \"10-2\": \"Unindex node from a user.\",\n    \"10-3\": \"100\",\n    \"11-0\": \"GET\",\n    \"11-1\": \"/users/<user:id>/trans\",\n    \"11-2\": \"View all transactions of a user (paginated).\",\n    \"11-3\": \"100\",\n    \"13-0\": \"POST\",\n    \"13-1\": \"/users/<user:id>/nodes/<node:id>/trans\",\n    \"13-2\": \"Allows you to create a transaction.\",\n    \"14-0\": \"GET\",\n    \"14-1\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"14-2\": \"View transaction info.\",\n    \"15-0\": \"PATCH\",\n    \"15-1\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"15-2\": \"Update notes on a transaction.\",\n    \"15-3\": \"100\",\n    \"16-0\": \"DELETE\",\n    \"16-1\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"16-2\": \"Only works if transaction has been created or queued.\",\n    \"16-3\": \"100\",\n    \"7-3\": \"100\",\n    \"8-3\": \"100\",\n    \"9-3\": \"100\",\n    \"13-3\": \"100\",\n    \"14-3\": \"100\",\n    \"0-0\": \"POST\",\n    \"0-1\": \"/oauth/<user:id>\",\n    \"0-2\": \"This API call allows you to get `oauth_key` for users.\",\n    \"0-3\": \"30\",\n    \"17-0\": \"GET\",\n    \"17-1\": \"/subscriptions\",\n    \"17-2\": \"View all subscriptions created with your client keys (paginated).\",\n    \"17-3\": \"10\",\n    \"18-0\": \"POST\",\n    \"18-1\": \"/subscriptions\",\n    \"18-2\": \"Create a subscription with webhook preferences.\",\n    \"18-3\": \"10\",\n    \"19-0\": \"GET\",\n    \"19-1\": \"/subscriptions/<subscription:id>\",\n    \"19-2\": \"View a subscription.\",\n    \"19-3\": \"10\",\n    \"20-0\": \"PATCH\",\n    \"20-1\": \"/subscriptions/<subscription:id>\",\n    \"20-2\": \"Update `scope`, `url`, `is_active`, etc.\",\n    \"20-3\": \"10\",\n    \"1-0\": \"POST\",\n    \"1-1\": \"/oauth/<user:id>/login\",\n    \"1-2\": \"Using basic auth to get `refresh_token` for users.\",\n    \"1-3\": \"30\",\n    \"12-0\": \"GET\",\n    \"12-1\": \"/users/<user:id>/nodes/<node:id>/trans\",\n    \"12-2\": \"View all transactions of a node (paginated).\",\n    \"12-3\": \"100\",\n    \"h-4\": \"Rate Limits (per min)\"\n  },\n  \"cols\": 4,\n  \"rows\": 21\n}\n[/block]","excerpt":"Following is the Map of the API","slug":"api-map-and-rate-limits","type":"basic","title":"API Map and Rate Limits"}

API Map and Rate Limits

Following is the Map of the API

Following is a map of the entire API including all of the API calls that are supported and what you can do with each call. [block:parameters] { "data": { "h-0": "HTTP Verb", "h-1": "URL", "h-2": "Functionality", "h-3": "Rate Limits (per min)", "2-0": "GET", "2-1": "/users", "2-2": "View all users created with your client keys (paginated).", "2-3": "100", "3-1": "/users", "3-0": "POST", "3-2": "Allows you to register a new user.", "3-3": "100", "4-0": "GET", "4-1": "/users/<user:id>", "4-2": "View user info and `refresh_token`.", "4-3": "30", "5-0": "PATCH", "5-1": "/users/<user:id>", "5-2": "Add/update KYC, log in credentials, profile, etc.", "5-3": "30", "6-0": "GET", "6-1": "/users/<user:id>/nodes", "6-2": "View all nodes linked to a user (paginated).", "6-3": "100", "7-0": "POST", "7-1": "/users/<user:id>/nodes", "7-2": "Allows you to create a deposit account or link an external bank account to a user.", "8-0": "GET", "8-1": "/users/<user:id>/nodes/<node:id>", "8-2": "View node info.", "9-0": "PATCH", "9-1": "/users/<user:id>/nodes/<node:id>", "9-2": "Update `supp_id`, verify micro-deposits, etc.", "10-1": "/users/<user:id>/nodes/<node:id>", "10-0": "DELETE", "10-2": "Unindex node from a user.", "10-3": "100", "11-0": "GET", "11-1": "/users/<user:id>/trans", "11-2": "View all transactions of a user (paginated).", "11-3": "100", "13-0": "POST", "13-1": "/users/<user:id>/nodes/<node:id>/trans", "13-2": "Allows you to create a transaction.", "14-0": "GET", "14-1": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "14-2": "View transaction info.", "15-0": "PATCH", "15-1": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "15-2": "Update notes on a transaction.", "15-3": "100", "16-0": "DELETE", "16-1": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "16-2": "Only works if transaction has been created or queued.", "16-3": "100", "7-3": "100", "8-3": "100", "9-3": "100", "13-3": "100", "14-3": "100", "0-0": "POST", "0-1": "/oauth/<user:id>", "0-2": "This API call allows you to get `oauth_key` for users.", "0-3": "30", "17-0": "GET", "17-1": "/subscriptions", "17-2": "View all subscriptions created with your client keys (paginated).", "17-3": "10", "18-0": "POST", "18-1": "/subscriptions", "18-2": "Create a subscription with webhook preferences.", "18-3": "10", "19-0": "GET", "19-1": "/subscriptions/<subscription:id>", "19-2": "View a subscription.", "19-3": "10", "20-0": "PATCH", "20-1": "/subscriptions/<subscription:id>", "20-2": "Update `scope`, `url`, `is_active`, etc.", "20-3": "10", "1-0": "POST", "1-1": "/oauth/<user:id>/login", "1-2": "Using basic auth to get `refresh_token` for users.", "1-3": "30", "12-0": "GET", "12-1": "/users/<user:id>/nodes/<node:id>/trans", "12-2": "View all transactions of a node (paginated).", "12-3": "100", "h-4": "Rate Limits (per min)" }, "cols": 4, "rows": 21 } [/block]