Most API methods are working and up-to-date with the current version of Snapchat, though there are some non-core methods which are untested. For example usage, please refer to the tests.
npm install snapchat
Snapchat defaults to using required signin credentials stored in environment variables:
SNAPCHAT_USERNAMEThe Snapchat username to sign in with.
SNAPCHAT_PASSWORDThe password to the Snapchat account to sign in with.
SNAPCHAT_GMAIL_EMAILA valid GMail address.
SNAPCHAT_GMAIL_PASSWORDThe password for the GMail address.
var Snapchat =var client =// note the signIn will default to credentials stored in environment variablesclient
Or with explicit credentials:
var Snapchat =var client =client
NOTE Only Snapchat accounts created via an Android client should be used with this library. iOS accounts are handled separately by Snapchat, and your account will most likely be flagged / disabled as suspicious if you try to use a Snapchat account created on iOS.
NOTE Any valid gmail address and password may be used; it does not have to be the one the Snapchat user was created with.
You can enable debug logs by setting the
DEBUG environment variable:
DEBUG=snapchat; # debug core snapchat
DEBUG=snapchat,snapchat:*; # debug all snapchat submodules
MIT. Copyright (c) Travis Fischer.
I believe it's 100% legal to use a "private" REST API and that there are no laws explicitly prohibiting the use of "private" REST APIs. However, this does not mean that the makers of these private APIs can't try to sue you under something overly-broad, such as the CFAA. I don't think Snapchat will, personally; in my experience they've only gone after developers for copyright disputes.
Disclaimer: The name "Snapchat" is a copyright of Snapchat™, Inc. This project is in no way affiliated with, sponsored, or endorsed by Snapchat™, Inc. I, the project owner and creator, am not responsible for any legalities that may arise in the use of this project. Use at your own risk.