@eryxenx/insta-chat 0.0.0-stage → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/DOCS.md +172 -0
- package/LICENSE +202 -0
- package/NOTICE +9 -0
- package/README.md +211 -2
- package/index.d.ts +116 -0
- package/index.js +7 -0
- package/package.json +55 -4
- package/src/api.js +7 -0
- package/src/constants.js +7 -0
- package/src/cookies.js +7 -0
- package/src/deviceIdentity.js +7 -0
- package/src/http.js +7 -0
- package/src/methods/inbox.js +7 -0
- package/src/methods/media.js +7 -0
- package/src/methods/message.js +7 -0
- package/src/methods/reactions.js +7 -0
- package/src/methods/thread.js +7 -0
- package/src/methods/typing.js +7 -0
- package/src/methods/user.js +7 -0
- package/src/session.js +7 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to `@eryxenx/insta-chat` are documented here.
|
|
4
|
+
The format follows [Keep a Changelog](https://keepachangelog.com/) and uses
|
|
5
|
+
[Semantic Versioning](https://semver.org/).
|
|
6
|
+
|
|
7
|
+
## [1.0.0] - 2025-09-15
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- Initial public release.
|
|
12
|
+
- `login(cookie, [options], [callback])` entry point (Promise + FCA-style callback).
|
|
13
|
+
- Messaging: `sendMessage`, `replyToMessage`, `sendLink`, `sendReaction`,
|
|
14
|
+
`removeReaction`, `unsendMessage`, `startTyping`, `stopTyping`.
|
|
15
|
+
- Media: `sendPhoto` / `sendVideo` / `sendVoice` (+ Buffer and URL variants).
|
|
16
|
+
- Threads: `getThreadInfo`, `getThreadHistory`, `markThreadSeen`,
|
|
17
|
+
`muteThread`, `unmuteThread`, `hideThread`.
|
|
18
|
+
- Users: `getUserInfo`, `getUserInfoByUsername`, `searchUsers`.
|
|
19
|
+
- Inbox: `getInbox`, `listen(cb, intervalMs)` returning a `stop()` function.
|
|
20
|
+
- `harvestSessionParams()` + `findChromium()` browser session-param capture.
|
|
21
|
+
- Pure-HTTP runtime (no browser after harvesting) via Relay GraphQL + `rupload`.
|
|
22
|
+
- Graceful reaction support through `IGDirectReactionMutation`.
|
|
23
|
+
|
|
24
|
+
## License change
|
|
25
|
+
- Relicensed from MIT to Apache-2.0 (original author credit and NOTICE must be retained).
|
package/DOCS.md
ADDED
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
# @eryxenx/insta-chat — API documentation
|
|
2
|
+
|
|
3
|
+
Unofficial Instagram Direct Message API for Node.js. This document describes the
|
|
4
|
+
public API and the reverse-engineered protocol the package speaks.
|
|
5
|
+
|
|
6
|
+
## Introduction
|
|
7
|
+
|
|
8
|
+
Instagram's web Direct client does **not** use the old
|
|
9
|
+
`/api/v1/direct_v2/...` REST endpoints any more — most of them now `404`
|
|
10
|
+
(Instagram answers with the login HTML shell). The current client uses **Relay
|
|
11
|
+
GraphQL** for reads and sends, and a dedicated `rupload` PUT for media. This
|
|
12
|
+
package reproduces that flow exactly, so it stays alive as long as the web
|
|
13
|
+
client does.
|
|
14
|
+
|
|
15
|
+
Because Instagram validates the browser **session params** (`__dyn`, `__csr`,
|
|
16
|
+
`__hs`, `__hsi`, `__s`, `fb_dtsg`, `jazoest`, `lsd`, ...) on every request,
|
|
17
|
+
you should supply them via `harvestSessionParams()` once per session.
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install @eryxenx/insta-chat
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Entry point
|
|
26
|
+
|
|
27
|
+
```javascript
|
|
28
|
+
const login = require("@eryxenx/insta-chat");
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`login(cookie, [options], [callback])` returns a `Promise<InstaAPI>` (or calls
|
|
32
|
+
back FCA-style). `cookie` accepts:
|
|
33
|
+
|
|
34
|
+
- a raw `sessionid=...` string,
|
|
35
|
+
- a full browser `Cookie` header (`"k=v; k=v; ..."`),
|
|
36
|
+
- a `{ name: value }` object,
|
|
37
|
+
- a browser-devtools cookie array (`[{ name, value }]`).
|
|
38
|
+
|
|
39
|
+
### options
|
|
40
|
+
|
|
41
|
+
| Key | Default | Meaning |
|
|
42
|
+
|-----|---------|---------|
|
|
43
|
+
| `sessionParams` | – | Pre-harvested browser session params. |
|
|
44
|
+
| `sessionParamsFile` | `./session-params.json` | Load params from disk. |
|
|
45
|
+
| `deviceFile` | `./device.json` | Persisted device identity. |
|
|
46
|
+
| `pollInterval` | `15000` | `listen()` poll interval (ms). |
|
|
47
|
+
|
|
48
|
+
## `InstaAPI`
|
|
49
|
+
|
|
50
|
+
### Identity
|
|
51
|
+
|
|
52
|
+
| Method | Description |
|
|
53
|
+
|--------|-------------|
|
|
54
|
+
| `init()` | Validate the session, resolve the user id/username, bootstrap tokens. Called by `login`. |
|
|
55
|
+
| `getCurrentUserID()` | The logged-in account id. |
|
|
56
|
+
| `refreshSession(params?)` | Swap in fresh session params. |
|
|
57
|
+
|
|
58
|
+
### Messaging
|
|
59
|
+
|
|
60
|
+
`sendMessage(text, threadID)`, `replyToMessage(threadID, text)`,
|
|
61
|
+
`sendLink(threadID, link, text)`, `sendReaction(threadID, itemID, emoji)`,
|
|
62
|
+
`removeReaction(threadID, itemID)`, `unsendMessage(threadID, itemID)`,
|
|
63
|
+
`startTyping(threadID)`, `stopTyping(threadID)`.
|
|
64
|
+
|
|
65
|
+
### Media
|
|
66
|
+
|
|
67
|
+
`sendPhoto` / `sendPhotoBuffer` / `sendPhotoFromUrl`,
|
|
68
|
+
`sendVideo` / `sendVideoBuffer` / `sendVideoFromUrl`,
|
|
69
|
+
`sendVoice` / `sendVoiceBuffer` / `sendVoiceFromUrl`.
|
|
70
|
+
|
|
71
|
+
All take `(threadID, source, options)` where `options = { filename, text }`.
|
|
72
|
+
|
|
73
|
+
### Threads
|
|
74
|
+
|
|
75
|
+
`getThreadInfo`, `getThreadHistory(threadID, limit)`,
|
|
76
|
+
`markThreadSeen(threadID, itemID)`, `muteThread`, `unmuteThread`, `hideThread`.
|
|
77
|
+
|
|
78
|
+
### Users
|
|
79
|
+
|
|
80
|
+
`getUserInfo(userID)`, `getUserInfoByUsername(username)`, `searchUsers(query, limit)`.
|
|
81
|
+
|
|
82
|
+
### Inbox / listening
|
|
83
|
+
|
|
84
|
+
`getInbox()` returns `{ threads }`. `listen(callback, intervalMs)` polls and
|
|
85
|
+
emits normalized `message` events; it returns a `stop()` function.
|
|
86
|
+
`stopListening()` also stops polling.
|
|
87
|
+
|
|
88
|
+
### Event shape
|
|
89
|
+
|
|
90
|
+
```javascript
|
|
91
|
+
{
|
|
92
|
+
type: "message",
|
|
93
|
+
threadID: "340282366842...",
|
|
94
|
+
senderID: "1234567890",
|
|
95
|
+
messageID: "mid.$cAAA...",
|
|
96
|
+
body: "hello",
|
|
97
|
+
attachments: [{ type: "photo", url: "https://...", caption: null }],
|
|
98
|
+
itemType: "text",
|
|
99
|
+
repliedToItemId: null,
|
|
100
|
+
timestamp: 1791442499484
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Protocol notes
|
|
105
|
+
|
|
106
|
+
### Endpoints (`src/constants.js`)
|
|
107
|
+
|
|
108
|
+
| Name | Value |
|
|
109
|
+
|------|-------|
|
|
110
|
+
| Web origin | `https://www.instagram.com` |
|
|
111
|
+
| GraphQL | `https://www.instagram.com/api/graphql` |
|
|
112
|
+
| rupload | `https://rupload.instagram.com/<consumer>/<uuid>` |
|
|
113
|
+
|
|
114
|
+
Relay **doc_ids** (stable per friendly-name, rotate rarely):
|
|
115
|
+
|
|
116
|
+
| Operation | doc_id |
|
|
117
|
+
|-----------|--------|
|
|
118
|
+
| `IGDirectTextSendMutation` | `26911679871773184` |
|
|
119
|
+
| `IGDirectMediaSendMutation` | `25766288509716264` |
|
|
120
|
+
| `IGDirectReactionMutation` | `24374451552236906` |
|
|
121
|
+
| `IGDirectAnimatedMediaSendMutation` | `32089613413987432` |
|
|
122
|
+
| `IGDirectCutoutStickerSendMutation` | `26601474479505807` |
|
|
123
|
+
| `PolarisDirectInboxQuery` | `27909866362025854` |
|
|
124
|
+
| `useFeatureLimitsOffMsysQuery` (login probe) | `28374543635529813` |
|
|
125
|
+
| Thread detail | `29619996517588618` |
|
|
126
|
+
|
|
127
|
+
### Text send
|
|
128
|
+
|
|
129
|
+
`IGDirectTextSendMutation` with variables:
|
|
130
|
+
`{ ig_thread_igid, offline_threading_id, text: { sensitive_string_value }, ... }`,
|
|
131
|
+
`Referer: https://www.instagram.com/direct/t/<threadID>/`.
|
|
132
|
+
|
|
133
|
+
### Media send
|
|
134
|
+
|
|
135
|
+
1. **Upload** the raw bytes with `PUT`-style POST to
|
|
136
|
+
`https://rupload.instagram.com/<consumer>/<uuid>?<sessionParams>`.
|
|
137
|
+
Consumer + type header from the MIME type (`messenger_image`/`image_type`,
|
|
138
|
+
`messenger_video`/`video_type`, `messenger_audio`/`audio_type`,
|
|
139
|
+
`messenger_gif`/`image_type`, `messenger_file`/`file_type`).
|
|
140
|
+
Instagram may answer `412 AuthorizationFailedError` transiently — the client
|
|
141
|
+
retries with backoff.
|
|
142
|
+
2. **Commit** with `IGDirectMediaSendMutation`:
|
|
143
|
+
`{ attachment_fbid, thread_id, offline_threading_id }`.
|
|
144
|
+
|
|
145
|
+
### Reactions
|
|
146
|
+
|
|
147
|
+
`IGDirectReactionMutation` with a **flat `input`** object:
|
|
148
|
+
|
|
149
|
+
```javascript
|
|
150
|
+
{ input: { emoji, item_id, message_id, reaction_status, thread_id } }
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
`reaction_status` is `"created"` or `"deleted"`. (Reverse-engineered from the
|
|
154
|
+
live `comet/CometDirectPageWeb` bundle; the legacy REST reaction endpoint 404s.)
|
|
155
|
+
|
|
156
|
+
### Session validation
|
|
157
|
+
|
|
158
|
+
The REST probe endpoints lie (they 302 to login even for healthy sessions), so
|
|
159
|
+
`isLoggedIn()` issues a cheap authenticated GraphQL call
|
|
160
|
+
(`useFeatureLimitsOffMsysQuery`) and treats any auth failure as logged out.
|
|
161
|
+
|
|
162
|
+
### `offline_threading_id`
|
|
163
|
+
|
|
164
|
+
Computed as `(unix_ms << 22) | rand(22 bits)` packed into a 64-bit integer.
|
|
165
|
+
Instagram rejects sends whose id does not decode to a recent timestamp.
|
|
166
|
+
|
|
167
|
+
## Limitations
|
|
168
|
+
|
|
169
|
+
- **Polling** inbox, not MQTT — there is a short delay before events arrive.
|
|
170
|
+
- Instagram rate-limits aggressively; keep a sane `pollInterval` and avoid
|
|
171
|
+
tight send loops.
|
|
172
|
+
- Only works for **personal** accounts with a valid browser session cookie.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
insta-chat
|
|
2
|
+
Copyright (c) 2026 EryXenX (https://github.com/EryXenX)
|
|
3
|
+
|
|
4
|
+
This product includes software developed by EryXenX.
|
|
5
|
+
|
|
6
|
+
Under the Apache License 2.0 you must keep this NOTICE file and the
|
|
7
|
+
copyright headers in every copy or derivative work, and you must state
|
|
8
|
+
clearly if you changed any file. Removing or replacing the original
|
|
9
|
+
author credit violates the license.
|
package/README.md
CHANGED
|
@@ -1,3 +1,212 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
# 💬 @eryxenx/insta-chat
|
|
4
|
+
|
|
5
|
+
**Unofficial Instagram DM Chat API for Node.js**
|
|
6
|
+
|
|
7
|
+
Send messages, media, voice notes & reactions · edit, unsend, listen · build Instagram bots on personal accounts · zero browser at runtime
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/@eryxenx/insta-chat)
|
|
10
|
+
[](./LICENSE)
|
|
11
|
+
[](https://nodejs.org)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## ⚡ What is this?
|
|
18
|
+
|
|
19
|
+
`@eryxenx/insta-chat` is a standalone Instagram **Direct Message** API — the
|
|
20
|
+
Instagram sibling of an FCA package. It talks to the same web endpoints
|
|
21
|
+
`www.instagram.com` uses (Relay GraphQL + `rupload`), so you can build a bot on
|
|
22
|
+
your own personal account:
|
|
23
|
+
|
|
24
|
+
- ✅ **Send** text, photos, videos, voice notes
|
|
25
|
+
- ✅ **React**, edit and unsend messages
|
|
26
|
+
- ✅ **Listen** for incoming DMs (polling) and dispatch them to your own commands
|
|
27
|
+
- ✅ **Typing** indicators, mark-seen, mute/unmute, hide
|
|
28
|
+
- ✅ **Users** — lookup by id / username, search
|
|
29
|
+
- ✅ **Pure HTTP at runtime** — no Puppeteer, no browser, no native build
|
|
30
|
+
|
|
31
|
+
> ⚠️ Unofficial. Not affiliated with Instagram or Meta. Use only on accounts you
|
|
32
|
+
> own and at your own risk. This package automates a personal account, not the
|
|
33
|
+
> official Instagram Business API.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 📦 Installation
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm install @eryxenx/insta-chat
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Requires **Node.js >= 18**.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 🚀 Quick start
|
|
48
|
+
|
|
49
|
+
```javascript
|
|
50
|
+
const login = require("@eryxenx/insta-chat");
|
|
51
|
+
|
|
52
|
+
// `cookie` is your browser cookie string (needs at least `sessionid`).
|
|
53
|
+
login(cookie, (err, api) => {
|
|
54
|
+
if (err) return console.error("Login error:", err.message);
|
|
55
|
+
console.log("Logged in as", api.username || api.userID);
|
|
56
|
+
|
|
57
|
+
// send a DM
|
|
58
|
+
api.sendMessage("Hello from my bot 👋", "340282366841710300949128138275732109616");
|
|
59
|
+
});
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Promise style works too:
|
|
63
|
+
|
|
64
|
+
```javascript
|
|
65
|
+
const api = await login(cookie);
|
|
66
|
+
await api.sendMessage("hi", threadID);
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Getting the cookie
|
|
70
|
+
|
|
71
|
+
Log in to <https://www.instagram.com> in a browser, open DevTools → Network →
|
|
72
|
+
copy the `Cookie` request header (it contains `sessionid`, `ds_user_id`,
|
|
73
|
+
`csrftoken`, `ig_did`). Paste the whole string; only `sessionid` is mandatory.
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## 🧠 Session params (important)
|
|
78
|
+
|
|
79
|
+
Instagram's web API rejects requests that do not carry the browser **session
|
|
80
|
+
params** (`__dyn`, `__csr`, `__hs`, `__hsi`, `__s`, `fb_dtsg`, `jazoest`, ...).
|
|
81
|
+
They are produced by Instagram's own JS bundle but are session-scoped, so one
|
|
82
|
+
real browser page load is enough — capture once, reuse until it expires.
|
|
83
|
+
|
|
84
|
+
```javascript
|
|
85
|
+
const { harvestSessionParams, findChromium } = require("@eryxenx/insta-chat");
|
|
86
|
+
|
|
87
|
+
const params = await harvestSessionParams({ /* cookie jar */ });
|
|
88
|
+
// -> { __dyn, __csr, __hs, fb_dtsg, lsd, ... }
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
`harvestSessionParams` drives a system Chrome/Chromium through `puppeteer-core`
|
|
92
|
+
(optional dependency, no browser download). Pass the result to `login`:
|
|
93
|
+
|
|
94
|
+
```javascript
|
|
95
|
+
const api = await login(cookie, { sessionParams: params });
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
If you skip this, the package still tries to bootstrap the minimum tokens
|
|
99
|
+
(`fb_dtsg`, `lsd`) from the Instagram home page automatically. When the params
|
|
100
|
+
go stale use `api.refreshSession()`.
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## 📚 API
|
|
105
|
+
|
|
106
|
+
### Login
|
|
107
|
+
|
|
108
|
+
| Call | Description |
|
|
109
|
+
|------|-------------|
|
|
110
|
+
| `login(cookie, [options], [cb])` | Returns/clbacks a ready `InstaAPI`. |
|
|
111
|
+
| `createClient(cookie, [options])` | Alias of `login`. |
|
|
112
|
+
|
|
113
|
+
`options`: `{ sessionParams, sessionParamsFile, deviceFile, pollInterval }`.
|
|
114
|
+
|
|
115
|
+
### Messaging
|
|
116
|
+
|
|
117
|
+
| Method | Description |
|
|
118
|
+
|--------|-------------|
|
|
119
|
+
| `sendMessage(text, threadID)` | Send a text DM. |
|
|
120
|
+
| `replyToMessage(threadID, text)` | Send a reply. |
|
|
121
|
+
| `sendLink(threadID, link, text)` | Send a link with optional text. |
|
|
122
|
+
| `sendReaction(threadID, itemID, emoji)` | React to a message. |
|
|
123
|
+
| `removeReaction(threadID, itemID)` | Remove a reaction. |
|
|
124
|
+
| `unsendMessage(threadID, itemID)` | Unsend a message. |
|
|
125
|
+
| `startTyping(threadID)` / `stopTyping(threadID)` | Typing indicator. |
|
|
126
|
+
|
|
127
|
+
### Media
|
|
128
|
+
|
|
129
|
+
| Method | Description |
|
|
130
|
+
|--------|-------------|
|
|
131
|
+
| `sendPhoto(threadID, filePath, [opts])` | Photo from disk. |
|
|
132
|
+
| `sendPhotoBuffer(threadID, buffer, [opts])` | Photo from a Buffer. |
|
|
133
|
+
| `sendPhotoFromUrl(threadID, url, [opts])` | Photo from a URL. |
|
|
134
|
+
| `sendVideo` / `sendVideoBuffer` / `sendVideoFromUrl` | Video variants. |
|
|
135
|
+
| `sendVoice` / `sendVoiceBuffer` / `sendVoiceFromUrl` | Voice-note variants. |
|
|
136
|
+
|
|
137
|
+
`opts`: `{ filename, text }`.
|
|
138
|
+
|
|
139
|
+
### Threads & users
|
|
140
|
+
|
|
141
|
+
| Method | Description |
|
|
142
|
+
|--------|-------------|
|
|
143
|
+
| `getThreadInfo(threadID)` | Thread metadata. |
|
|
144
|
+
| `getThreadHistory(threadID, limit)` | Recent messages. |
|
|
145
|
+
| `markThreadSeen(threadID, itemID)` | Mark as read. |
|
|
146
|
+
| `muteThread` / `unmuteThread` / `hideThread` | Thread state. |
|
|
147
|
+
| `getUserInfo(userID)` / `getUserInfoByUsername(username)` | User lookup. |
|
|
148
|
+
| `searchUsers(query, limit)` | Search users. |
|
|
149
|
+
|
|
150
|
+
### Listening
|
|
151
|
+
|
|
152
|
+
```javascript
|
|
153
|
+
const stop = api.listen((err, event) => {
|
|
154
|
+
if (err) return console.error(err.message);
|
|
155
|
+
console.log(event.senderID, "->", event.body);
|
|
156
|
+
// event = { type, threadID, senderID, messageID, body, attachments, timestamp }
|
|
157
|
+
});
|
|
158
|
+
|
|
159
|
+
// later
|
|
160
|
+
stop();
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
`listen` polls the inbox (default every 15s, override with `options.pollInterval`).
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
## 🧩 Example — a tiny DM bot
|
|
168
|
+
|
|
169
|
+
```javascript
|
|
170
|
+
const login = require("@eryxenx/insta-chat");
|
|
171
|
+
|
|
172
|
+
(async () => {
|
|
173
|
+
const api = await login(process.env.IG_COOKIE);
|
|
174
|
+
|
|
175
|
+
api.listen(async (err, event) => {
|
|
176
|
+
if (err || !event || !event.body) return;
|
|
177
|
+
if (event.body === "/ping") await api.sendMessage("pong 🏓", event.threadID);
|
|
178
|
+
await api.sendReaction(event.threadID, event.messageID, "✅");
|
|
179
|
+
});
|
|
180
|
+
})();
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## 🗂️ Project structure
|
|
186
|
+
|
|
187
|
+
| Path | Description |
|
|
188
|
+
|------|-------------|
|
|
189
|
+
| `index.js` | Entry point; exports `login` + helpers. |
|
|
190
|
+
| `index.d.ts` | TypeScript definitions. |
|
|
191
|
+
| `src/api.js` | `InstaAPI` facade wiring every method group. |
|
|
192
|
+
| `src/http.js` | HTTP client: web headers, session params, GraphQL, rupload. |
|
|
193
|
+
| `src/constants.js` | Endpoint + Relay `doc_id` table. |
|
|
194
|
+
| `src/cookies.js` | Cookie parsing / normalization. |
|
|
195
|
+
| `src/session.js` | Browser session-param harvesting (`puppeteer-core`). |
|
|
196
|
+
| `src/deviceIdentity.js` | Persisted device identity. |
|
|
197
|
+
| `src/methods/` | `message`, `media`, `reactions`, `thread`, `user`, `inbox`, `typing`. |
|
|
198
|
+
|
|
199
|
+
See [DOCS.md](./DOCS.md) for the full protocol notes (GraphQL doc_ids, send /
|
|
200
|
+
upload / reaction flows).
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## 📋 Changelog
|
|
205
|
+
|
|
206
|
+
See [CHANGELOG.md](./CHANGELOG.md).
|
|
207
|
+
|
|
208
|
+
## 📄 License
|
|
209
|
+
|
|
210
|
+
[Apache-2.0](./LICENSE) © EryXenX
|
|
211
|
+
|
|
212
|
+
> **Credit required:** you may use and modify this library, but you must keep the original copyright headers, the `NOTICE` file and the author credit (EryXenX), and clearly state your changes. Removing or replacing the credit violates the license.
|