NinjaPear Tổng quan

NinjaPear là một nền tảng Trí tuệ Công ty B2B tập trung vào quyền sở hữu dữ liệu và cung cấp có đạo đức. Là một nhà cung cấp bên thứ nhất, chúng tôi duy trì một hệ sinh thái bền vững của dữ liệu độc quyền và được kiểm duyệt pháp lý. Sứ mệnh của chúng tôi là cung cấp một cơ sở hạ tầng dữ liệu đáng tin cậy, cho phép các doanh nghiệp phát triển và mở rộng quy mô các ứng dụng và quy trình làm việc có giá trị cao với sự tự tin.

Cho các tác nhân AI

Xây dựng bằng agent mã hóa AI? Sử dụng phiên bản Markdown thuần túy của các tài liệu này - được tối ưu hóa cho LLM và công cụ AI như Claude, Cursor và ChatGPT:

Tài liệu thân thiện LLM (Markdown) — tham chiếu API đầy đủ dưới dạng văn bản thuần túy, sẵn sàng để dán hoặc kéo và thả vào bất kỳ cuộc trò chuyện AI nào
llms.txt — chỉ mục nhẹ để khám phá agent AI
OpenAPI 3.0 Spec — lược đồ API có thể đọc được bằng máy

AI Skill

NinjaPear AI Skill cung cấp cho các tác nhân mã hóa kiến thức thủ tục để viết mã tích hợp NinjaPear chính xác trong các ứng dụng của bạn. Cài đặt nó bằng một lệnh duy nhất và tác nhân của bạn sẽ biết cách xác thực, chọn điểm cuối phù hợp, tạo mã SDK và xử lý các trường hợp đặc biệt - tất cả đều có nhận thức chi phí tích hợp sẵn.

Kho lưu trữ GitHub

Điều kiện tiên quyết — Một khóa API NinjaPear từ nubela.co/dashboard và Node.js 18+.

Cài đặt kỹ năng bằng cách sử dụng npx skills CLI. Chọn lệnh cho đại lý của bạn:

Claude Code

npx skills add NinjaPear/ninjapear-skill -a claude-code

Codex

npx skills add NinjaPear/ninjapear-skill -a codex

Opencode

npx skills add NinjaPear/ninjapear-skill -a opencode

Thêm -g cờ cho cài đặt toàn cục (cấp độ người dùng) thay vì cấp độ dự án. Ví dụ: npx skills add NinjaPear/ninjapear-skill -a claude-code -g

Những Gì Tính Năng Cung Cấp

Sau khi cài đặt, kỹ năng cấp cho tác nhân mã hóa của bạn kiến thức thủ tục để hoạt động với NinjaPear một cách chính xác:

Khả năng	Mô tả
Thiết lập xác thực	Định cấu hình khóa API thông qua các biến môi trường và khởi tạo SDK
Lựa chọn điểm cuối	Chọn điểm cuối API NinjaPear phù hợp với nhận thức về chi phí
Tích hợp SDK Python	Tạo mã chính xác bằng cách sử dụng `ninjapear` Gói Python
Tích hợp SDK JavaScript	Tạo mã chính xác bằng cách sử dụng `ninjapear` gói npm
Xử lý phân trang	Triển khai phân trang dựa trên con trỏ cho điểm cuối danh sách
Xử lý giới hạn tỷ lệ	Tôn trọng giới hạn tốc độ bằng logic thử lại và lùi thích hợp
Xử lý lỗi	Xử lý tất cả các mã lỗi NinjaPear (401, 403, 404, 429, 500, 503)
Cấu hình thời gian chờ	Đặt thời gian chờ thích hợp cho các điểm cuối chạy dài

Giải thích cho tôi như tôi là một đứa trẻ 5 tuổi

Lấy danh sách khách hàng, nhà đầu tư và đối tác của bất kỳ công ty nào bằng Điểm cuối Danh sách Khách hàng.
Tìm đối thủ cạnh tranh của bất kỳ công ty nào và lý do tại sao họ cạnh tranh với Điểm cuối Danh sách đối thủ cạnh tranh.
Lấy danh mục sản phẩm và dịch vụ của công ty bằng Điểm cuối Danh sách sản phẩm.
Lấy logo của bất kỳ công ty nào miễn phí bằng Điểm cuối Logo Công ty.
Lấy chi tiết đầy đủ công ty như ngành, mô tả, giám đốc điều hành và vị trí văn phòng bằng Điểm cuối Chi tiết Công ty.
Lấy số lượng nhân viên của bất kỳ công ty nào bằng Điểm cuối Số lượng Nhân viên.
Lấy các bài đăng blog gần đây và cập nhật phương tiện truyền thông xã hội của bất kỳ công ty nào bằng Điểm cuối Cập nhật Công ty.
Lấy lịch sử vốn đầu tư đầy đủ và các nhà đầu tư của bất kỳ công ty nào bằng Điểm cuối Vốn đầu tư Công ty.
Phân giải tên công ty thành URL trang web chính tắc của nó với Điểm cuối Tra cứu Trang web.
Tìm email công việc của một người dựa trên tên và tên miền công ty với Điểm cuối Email Công Việc.
Tra cứu hồ sơ, lịch sử công việc và giáo dục của một người từ email công việc của họ bằng Điểm cuối Hồ sơ Người.
Tìm những người tương tự như một người mục tiêu — vai trò giống nhau tại các công ty cạnh tranh — với Điểm cuối Những Người Tương Tự.
Kiểm tra xem địa chỉ email có phải là dùng một lần hay từ nhà cung cấp email miễn phí bằng Điểm cuối Trình kiểm tra Email Dùng một lần.
Theo dõi công ty để tìm các bài đăng blog mới, tweet và thay đổi trang web thông qua RSS bằng Monitor API.
Kiểm tra tín dụng API còn lại của bạn bằng Xem Điểm cuối Số dư Tín dụng.

Xác thực

curl "https://nubela.co/api/v1/customer/listing" \
  -H "Authorization: Bearer YOUR_API_KEY"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CustomerAPIApi(api_client)
    response = api.get_customer_listing(website="https://example.com")

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
var bearerAuth = defaultClient.authentications["bearerAuth"];
bearerAuth.accessToken = "YOUR_API_KEY";

var api = new NinjaPear.CustomerAPIApi();
api.getCustomerListing("https://example.com").then(function (data) {
  console.log(data);
});

API NinjaPear sử dụng bearer tokens để xác thực người dùng. Mỗi người dùng được gán một khóa bí mật được tạo ngẫu nhiên dưới Phần API trong bảng điều khiển.

Token của người mang được tiêm vào Authorization tiêu đề.

Thư viện Máy khách

Chúng tôi cung cấp các thư viện ứng dụng khách chính thức cho JavaScript và Python để giúp tích hợp với API NinjaPear dễ dàng hơn.

JavaScript (Node.js)

npm install ninjapear

# JavaScript library - see JavaScript tab

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
var bearerAuth = defaultClient.authentications["bearerAuth"];
bearerAuth.accessToken = "YOUR_API_KEY";

// Now you can use any API class
var companyApi = new NinjaPear.CompanyAPIApi();
var customerApi = new NinjaPear.CustomerAPIApi();
var productApi = new NinjaPear.ProductAPIApi();
var contactApi = new NinjaPear.ContactAPIApi();
var metaApi = new NinjaPear.MetaAPIApi();

Python

uv add ninjapear
# or: pip install ninjapear

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

# Use the client with a context manager
with ninjapear.ApiClient(configuration) as api_client:
    company_api = ninjapear.CompanyAPIApi(api_client)
    customer_api = ninjapear.CustomerAPIApi(api_client)
    product_api = ninjapear.ProductAPIApi(api_client)
    contact_api = ninjapear.ContactAPIApi(api_client)
    meta_api = ninjapear.MetaAPIApi(api_client)

// Python library - see Python tab

Giới hạn tỷ lệ

Giới hạn tỷ lệ được thực thi trên mỗi tài khoản sản phẩm và được chia sẻ bởi tất cả các khóa API trong sản phẩm đó.

Các điểm cuối API trả phí được giới hạn ở 50 yêu cầu trên mỗi phút.

Để giới hạn tốc độ, Monitor nguồn cấp và các điểm cuối quản lý mục tiêu được tính là traffic API trả tiền ngay cả khi chi phí tín dụng của điểm cuối là 0.

Trong các giai đoạn tải cao, hệ thống của chúng tôi có thể siết chặt giới hạn tốc độ cho tất cả các tài khoản để đảm bảo rằng dịch vụ của chúng tôi vẫn có thể truy cập được cho tất cả người dùng.

Chúng tôi trả về HTTP 429 khi bạn bị giới hạn tốc độ. Bạn cũng có thể nhận HTTP 429 nếu khả năng ở phía chúng tôi giới hạn chúng tôi.

Bạn nên xử lý các lỗi 429 và áp dụng quay lùi theo cấp số nhân.

Các phản hồi bị giới hạn tỷ lệ bao gồm:

Tiêu đề	Mô tả
`Retry-After`	Giây để chờ trước khi thử lại
`X-RateLimit-Limit`	Số yêu cầu tối đa được phép trong phút hiện tại
`X-RateLimit-Remaining`	Số yêu cầu còn lại trong phút hiện tại
`X-RateLimit-Reset`	Dấu thời gian Unix khi phút hiện tại được đặt lại

Giới hạn tỷ lệ cho các API miễn phí

Để cung cấp API miễn phí một cách bền vững, giới hạn tỷ lệ cho API miễn phí tùy thuộc vào kế hoạch đăng ký của bạn:

Gói miễn phí, dùng thử hoặc PAYG: 2 yêu cầu/phút
Gói $49/tháng: 20 yêu cầu/phút
Gói $299/tháng: 50 yêu cầu/phút
Gói $899/tháng: 100 yêu cầu/phút
Gói $1899/tháng: 300 yêu cầu/phút

Giới hạn tỷ lệ API miễn phí áp dụng cho Company Logo, Disposable Email Checker, View Credit Balance và tiêu thụ nguồn cấp RSS.

Tín dụng

Mỗi yêu cầu hợp lệ yêu cầu ít nhất 0.1 tín dụng cần được xử lý, trừ khi đó là một điểm cuối API miễn phí.

Một tín dụng được tiêu thụ nếu và chỉ nếu yêu cầu được phân tích cú pháp thành công.

Một yêu cầu thành công là một yêu cầu trả về với một 200 Mã trạng thái HTTP.

Thanh toán Bộ nhớ cache

Đối với các điểm cuối có use_cache tham số, sản phẩm không bị tính phí tín dụng lại khi cùng một yêu cầu chuẩn hóa được phục vụ từ cùng một phiên bản bản ghi được lưu trong bộ đệm mà sản phẩm đã trả tiền trước đây. Phản hồi bao gồm X-NinjaPear-Credit-Cost: 0 cho những lần trúng bộ đệm lặp lại này.

use_cache=never luôn thực hiện kéo dữ liệu mới và tính phí bình thường. use_cache=if-recent chỉ đủ điều kiện cho một lần lặp lại miễn phí trong khi bản ghi được lưu trong bộ đệm nằm trong cửa sổ làm mới của điểm cuối đó.

Đối với các điểm cuối được phân trang, quyền truy cập miễn phí lặp lại bị giới hạn đối với các trang đã được trả tiền với cùng một truy vấn, bộ lọc, chuỗi con trỏ và page_size. Các trang phân trang có trả tiền được phát lại chính xác khi bộ nhớ cache bị truy cập lại, bao gồm next_page giá trị. Các trang sau còn chưa thanh toán vẫn sẽ tính phí bình thường.

Hết thời gian chờ và thời gian phản hồi API

NinjaPear API điểm cuối chấp nhận 30-60 giây để hoàn thành.

Bạn được khuyến khích thực hiện các yêu cầu đồng thời đến dịch vụ API của chúng tôi để tối đa hóa thông lượng. Xem bài đăng này về cách bạn có thể tối đa hóa thông lượng.

Chúng tôi khuyên bạn nên đặt timeout là 100 giây.

Lỗi

Đây là những lỗi phổ biến có thể được trả về bởi API của chúng tôi:

Mã HTTP	Tính phí?	Mô tả
400	Không	Các tham số không hợp lệ. Tham khảo tài liệu và nội dung thông báo để biết thêm thông tin
401	Không	API Key không hợp lệ
403	Không	Bạn đã hết tín dụng
404	Có	Không tìm thấy tài nguyên được yêu cầu (ví dụ: hồ sơ người dùng, công ty)
410	Không	API này không được dùng nữa
429	Không	Đã đạt giới hạn tỷ lệ. Vui lòng thử lại
500	Không	Có lỗi với API của chúng tôi. Vui lòng Liên hệ chúng tôi để được hỗ trợ
503	Không	Làm giàu dữ liệu thất bại, vui lòng thử lại.

Bạn sẽ không bao giờ bị tính phí cho yêu cầu thất bại.

Bảo đảm Tương thích Ngược

Chúng tôi cam kết đảm bảo rằng API của chúng tôi vẫn tương thích ngược, cho phép bạn tích hợp với tự tin. Bảo đảm tương thích ngược của chúng tôi có nghĩa là chúng tôi sẽ không giới thiệu những thay đổi làm hỏng chức năng hiện có hoặc xóa các điểm cuối mà không có giai đoạn không dùng nữa.

Cụ thể, chúng tôi sẽ không giới thiệu những thay đổi phá vỡ theo những cách sau:

Chúng tôi sẽ không xóa các tham số được ghi lại và thuộc tính phản hồi.
Chúng tôi sẽ không thay đổi kiểu dữ liệu như được ghi trong các phản hồi API của chúng tôi.

Tuy nhiên, những điều sau không được coi là những thay đổi đột phá:

Thêm thuộc tính/tham số vào các điểm cuối API mà không thông báo trước.
Thêm các tiêu đề phản hồi hoặc yêu cầu bổ sung vào các điểm cuối API của chúng tôi mà không thông báo trước.

Chúng tôi rất khuyên bạn nên tích hợp API của chúng tôi theo cách không bị hỏng nếu các thuộc tính phản hồi hoặc tiêu đề mới được giới thiệu.

Nếu chúng tôi thực hiện thay đổi đối với API, chúng tôi sẽ cung cấp tài liệu rõ ràng và thông báo đầy đủ (30 ngày) để đảm bảo quá trình chuyển đổi liền mạch. Thông báo sẽ được chia sẻ qua email bản tin, bài đăng Twitter/X và cập nhật blog của chúng tôi.

API Khách hàng

Điểm cuối Danh sách Khách hàng

GET /api/v1/customer/listing

Chi phí: 1 tín dụng / yêu cầu + 2 tín dụng / công ty được trả về. Tín dụng được tính phí ngay cả khi yêu cầu trả về kết quả trống.

Lấy danh sách khách hàng, nhà đầu tư và đối tác/nền tảng có khả năng cao của công ty mục tiêu, được phân loại theo loại mối quan hệ.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "website=https://www.stripe.com" \
  "https://nubela.co/api/v1/customer/listing"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CustomerAPIApi(api_client)
    response = api.get_customer_listing(website="https://www.stripe.com")
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.CustomerAPIApi();
api.getCustomerListing("https://www.stripe.com").then(function (data) {
  console.log(data);
});

Phản hồi ví dụ:

{
  "customers": [
    {
      "name": "Apple",
      "description": "Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide.",
      "tagline": "Think different.",
      "website": "https://www.apple.com",
      "company_logo_url": "https://nubela.co/api/v1/company/logo?website=https%3A%2F%2Fwww.apple.com",
      "id": "abc123",
      "industry": 45202030,
      "specialties": ["Technology", "Consumer Electronics"],
      "x_profile": "https://x.com/Apple"
    }
  ],
  "investors": [
    {
      "name": "Sequoia Capital",
      "description": "Sequoia Capital is a venture capital firm focused on technology companies.",
      "tagline": null,
      "website": "https://www.sequoiacap.com",
      "company_logo_url": "https://nubela.co/api/v1/company/logo?website=https%3A%2F%2Fwww.sequoiacap.com",
      "id": "def456",
      "industry": 40203010,
      "specialties": ["Venture Capital", "Growth Equity"],
      "x_profile": "https://x.com/sequoia"
    }
  ],
  "partner_platforms": [
    {
      "name": "Amazon Web Services",
      "description": "Amazon Web Services provides cloud computing platforms and APIs.",
      "tagline": null,
      "website": "https://aws.amazon.com",
      "company_logo_url": "https://nubela.co/api/v1/company/logo?website=https%3A%2F%2Faws.amazon.com",
      "id": "ghi789",
      "industry": 45101010,
      "specialties": ["Cloud Computing", "Infrastructure"],
      "x_profile": "https://x.com/awscloud"
    }
  ],
  "next_page": "https://nubela.co/api/v1/customer/listing?website=https://www.stripe.com&cursor=abc123"
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`trang web`	Có	URL trang web hoặc tên công ty của công ty đích. URL trang web (ví dụ: `https://www.stripe.com`) được khuyên dùng mạnh mẽ để đạt độ chính xác.	`https://www.stripe.com`
`cursor`	Không	Con trỏ phân trang từ `next_page` trong một phản hồi trước đó	`abc123`
`page_size`	Không	Số lượng kết quả trên mỗi trang (1-200, mặc định 200)	`50`
`quality_filter`	Không	Lọc bỏ các kết quả kém chất lượng (junk TLDs như `.top`, `.xyz` và các trang web không thể truy cập). Đặt thành `false` để bao gồm tất cả các kết quả. (mặc định: `true`)	`false`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 29 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (mặc định; trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-present`

Phản hồi

Khóa	Mô tả	Ví dụ
`customers`	Danh sách các công ty là khách hàng có khả năng của công ty mục tiêu. Các thực thể trả tiền cho sản phẩm/dịch vụ của mục tiêu.	List of CustomerCompany objects
`investors`	Danh sách các công ty là nhà đầu tư (công ty VC, quỹ PE, mạng lưới thiên thần) của công ty mục tiêu.	List of CustomerCompany objects
`partner_platforms`	Danh sách các công ty là đối tác, nền tảng hoặc nhà cung cấp dịch vụ mà công ty mục tiêu sử dụng hoặc tích hợp với (tech stack, media, agencies).	List of CustomerCompany objects
`next_page`	URI API dùng làm con trỏ để phân trang. Theo dõi URL này với khóa API của bạn sẽ dẫn bạn đến trang kết quả tiếp theo. Giá trị này sẽ là null cho trang cuối cùng.	`https://nubela.co/api/v1/customer/list?...`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Không thể trích xuất đủ thông tin về công ty mục tiêu
404	Không	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`

Khách hàngCông ty

Khóa	Mô tả	Ví dụ
`name`	Tên công ty	`"Apple"`
`description`	Mô tả ngắn về công ty	`"Apple Inc. designs, manufactures, and markets smartphones..."`
`tagline`	Khẩu hiệu hoặc slogan của công ty	`"Think different."`
`trang web`	URL trang web công ty	`"https://www.apple.com"`
`company_logo_url`	Đường dẫn URL đến API Logo Công ty cho công ty này. Được cung cấp bởi Điểm cuối Logo Công ty. Xác thực bằng token bearer của bạn. `null` nếu không có trang web.	`"https://nubela.co/api/v1/company/logo?website=https%3A%2F%2Fwww.apple.com"`
`id`	Mã định danh duy nhất	`"abc123"`
`industry`	Mã ngành GICS 8 chữ số	`45202030`
`specialties`	Danh sách các chuyên ngành của công ty	`["Technology"]`
`x_profile`	URL hồ sơ X (Twitter)	`"https://x.com/Apple"`

Ghi chú về company_logo_url: URL này được cung cấp bởi Điểm cuối Logo Công ty. Xác thực bằng token Bearer của bạn (giống như API chính). Đây là các liên kết tạm thời — cách tiếp cận được khuyến nghị là tải xuống hình ảnh qua URL ngay khi phản hồi được trả lại và lưu trữ hình ảnh ở phía bạn.

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`10`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`12`

API Đối thủ cạnh tranh

Điểm cuối Danh sách đối thủ cạnh tranh

GET /api/v1/competitor/listing

Chi phí: 2 tín dụng / đối thủ cạnh tranh được trả về. Tối thiểu 5 tín dụng mỗi yêu cầu, được tính ngay cả khi không tìm thấy kết quả nào.

Lấy danh sách các công ty đối thủ cạnh tranh cho công ty mục tiêu, kèm theo lý do cạnh tranh.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "website=https://www.stripe.com" \
  "https://nubela.co/api/v1/competitor/listing"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CompetitorAPIApi(api_client)
    response = api.get_competitor_listing(website="https://www.stripe.com")
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.CompetitorAPIApi();
api.getCompetitorListing("https://www.stripe.com").then(function (data) {
  console.log(data);
});

Phản hồi ví dụ:

{
  "competitors": [
    {
      "company_details_url": "https://nubela.co/api/v1/company/details?website=https://www.adyen.com",
      "website": "https://www.adyen.com",
      "competition_reason": "product_overlap"
    },
    {
      "company_details_url": "https://nubela.co/api/v1/company/details?website=https://squareup.com",
      "website": "https://squareup.com",
      "competition_reason": "product_overlap"
    },
    {
      "company_details_url": "https://nubela.co/api/v1/company/details?website=https://www.checkout.com",
      "website": "https://www.checkout.com",
      "competition_reason": "organic_keyword_overlap"
    }
  ]
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`trang web`	Có	URL trang web hoặc tên công ty của công ty đích. URL trang web (ví dụ: `https://www.stripe.com`) được khuyên dùng mạnh mẽ để đạt độ chính xác.	`https://www.stripe.com`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 29 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (mặc định; trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-present`

Phản hồi

Khóa	Mô tả	Ví dụ
`competitors`	Danh sách các công ty đối thủ cạnh tranh cho công ty mục tiêu.	Danh sách Đối thủ cạnh tranhCông ty đối tượng

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Không thể trích xuất đủ thông tin về công ty mục tiêu
404	Không	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`

Đối thủ cạnh tranhCông ty

Khóa	Mô tả	Ví dụ
`company_details_url`	Đường dẫn URL đến điểm cuối Chi tiết Công ty cho đối thủ cạnh tranh này. Xác thực bằng mã token của bạn để lấy chi tiết công ty đầy đủ.	`"https://nubela.co/api/v1/company/details?website=https://www.adyen.com"`
`trang web`	URL trang web công ty	`"https://www.adyen.com"`
`competition_reason`	Tại sao công ty này được coi là đối thủ cạnh tranh. Một trong những giá trị từ Lý do Cạnh tranh enum.	`"product_overlap"`

Enum Lý do Cạnh tranh

Giá trị	Mô tả
`organic_keyword_overlap`	Cả hai công ty xếp hạng cho các từ khóa tìm kiếm hữu cơ tương tự
`product_overlap`	Cả hai công ty đều cung cấp các sản phẩm hoặc dịch vụ tương tự

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`4`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`12`

API Sản phẩm

Điểm cuối Danh sách sản phẩm

GET /api/v1/product/listing

Chi phí: 3 tín dụng / yêu cầu. Tín dụng được tính ngay cả khi không tìm thấy sản phẩm nào cho một công ty hợp lệ.

Lấy danh sách sản phẩm và dịch vụ được cung cấp bởi công ty mục tiêu.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "website=https://matterport.com" \
  "https://nubela.co/api/v1/product/listing"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.ProductAPIApi(api_client)
    response = api.get_product_listing(website="https://matterport.com")
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.ProductAPIApi();
api.getProductListing("https://matterport.com").then(function (data) {
  console.log(data);
});

Phản hồi ví dụ:

{
  "products": [
    {
      "name": "Matterport Digital Twin Platform",
      "tagline": "Capture, share, and collaborate in immersive 3D.",
      "description": "Matterport's 3D digital twin platform allows users to create immersive 3D models of physical spaces, enabling virtual tours, detailed measurements, and remote collaboration. It helps optimize space planning, manage costs, and streamline project management across various industries.",
      "categories": [
        "3D Modeling",
        "Digital Twins",
        "Virtual Tours",
        "Real Estate",
        "Construction",
        "Facilities Management"
      ],
      "tags": [],
      "structured_features": {
        "3d_insights": true,
        "centralized_management": true,
        "workplace_planning": true,
        "risk_mitigation": true,
        "bim_cad_generation": true,
        "qa_qc_monitoring": true,
        "asset_documentation": true,
        "space_planning": true,
        "capital_project_execution": true,
        "remote_oversight": true,
        "dimensionally_accurate_data": true,
        "secure_cloud_hosting": true
      },
      "freeform_features": [
        "immersive exploration from the palm of your hand",
        "cut the time and cost of workplace planning",
        "accelerating your ability to execute",
        "unmatched 3D visual clarity"
      ],
      "pricing": {
        "model": "unknown",
        "starts_at_monthly_usd": null,
        "tiers": []
      },
      "integrations": [
        "Procore",
        "Autodesk",
        "AWS"
      ],
      "platforms": [
        "web"
      ],
      "source_urls": [
        "http://matterport.com/",
        "https://go.matterport.com/corporate-occupiers.html",
        "https://matterport.com/solutions/design-construction",
        "http://matterport.com/solutions/corporate-real-estate",
        "http://matterport.com/contact-sales"
      ]
    }
  ]
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`trang web`	Có	URL trang web hoặc tên công ty của công ty đích. URL trang web (ví dụ: `https://matterport.com`) được khuyên dùng mạnh mẽ để đạt độ chính xác.	`https://matterport.com`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (mặc định; sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 29 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-recent`

Phản hồi

Khóa	Mô tả	Ví dụ
`products`	Danh sách các sản phẩm và dịch vụ do công ty mục tiêu cung cấp. Trả về danh sách trống khi công ty hợp lệ nhưng không phát hiện sản phẩm hoặc dịch vụ nào.	Danh sách Đối tượng Sản phẩm đối tượng

Đối tượng Sản phẩm

Khóa	Mô tả	Ví dụ
`name`	Tên đầy đủ của sản phẩm hoặc dịch vụ. Các sản phẩm, SKU, nền tảng hoặc dịch vụ được định giá riêng được trả về dưới dạng các hàng riêng biệt.	`"Matterport Digital Twin Platform"`
`tagline`	Khẩu hiệu sản phẩm một dòng khi có sẵn.	`"Capture, share, and collaborate in immersive 3D."`
`description`	Từ một đến ba câu mô tả những gì sản phẩm thực hiện.	`"Matterport's 3D digital twin platform allows users to create immersive 3D models of physical spaces..."`
`categories`	Danh mục sản phẩm, bao gồm loại sản phẩm, ngành công nghiệp hoặc nhóm trường hợp sử dụng được hỗ trợ bởi trang web.	`["3D Modeling", "Digital Twins"]`
`tags`	Các thuộc tính sản phẩm ngắn, kiểu triển khai, nhãn công nghệ hoặc các thẻ có thể tìm kiếm khác.	`["ai-powered", "self-hosted"]`
`structured_features`	Bản đồ tính năng sử dụng các khoá tính năng canonical và giá trị boolean, string hoặc numeric. Các khoá khác nhau tùy thuộc vào danh mục sản phẩm.	`{ "secure_cloud_hosting": true }`
`freeform_features`	Các cụm từ tính năng không phù hợp với khoá canonical.	`["unmatched 3D visual clarity"]`
`pricing`	Mô hình giá, giá bắt đầu và các mức khi giá có sẵn. `null` khi không thể xác định giá.	Đối tượng Giá
`integrations`	Tên sản phẩm, nền tảng hoặc dịch vụ mà sản phẩm này tích hợp với.	`["Procore", "Autodesk", "AWS"]`
`platforms`	Các nền tảng nơi sản phẩm có sẵn, chẳng hạn như `web`, `ios`, `android`, `macos`, `windows`, `linux`, `api`, `cli`, hoặc `chrome-extension`.	`["web"]`
`source_urls`	Các đường dẫn URL từ trang web công ty mục tiêu nơi dữ liệu sản phẩm được tìm thấy.	`["https://matterport.com/solutions/design-construction"]`

Đối tượng Giá

Khóa	Mô tả	Ví dụ
`model`	Mô hình giá. Một trong các giá trị từ Enum Mô hình giá.	`"subscription"`
`starts_at_monthly_usd`	Giá USD hàng tháng thấp nhất được tìm thấy trên trang web của công ty. `null` khi không rõ hoặc không có sẵn.	`29.0`
`tiers`	Các mức giá được tìm thấy trên trang web công ty.	Danh sách Đối tượng PricingTier đối tượng

Đối tượng PricingTier

Khóa	Mô tả	Ví dụ
`name`	Tên mức giá.	`"Business"`
`price_usd_monthly`	Giá USD hàng tháng cho tầng này. `null` khi không rõ.	`99.0`
`features`	Các tính năng được liệt kê cho mức giá này.	`["SSO", "Audit logs"]`

Enum Mô hình giá

Giá trị	Mô tả
`freemium`	Gói miễn phí với các nâng cấp trả tiền
`subscription`	Gói đăng ký thanh toán định kỳ
`one-time`	Mua một lần
`payg`	Bảng giá trả theo lượng sử dụng
`enterprise`	Giá cả doanh nghiệp tùy chỉnh
`unknown`	Giá tồn tại hoặc có thể tồn tại, nhưng mô hình không rõ ràng

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`3`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`12`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Không thể truy cập website hoặc đầu vào không hợp lệ
404	Không	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`
503	Không	Dung lượng thu thập tạm thời bão hòa. Hãy thử lại sau một khoảng thời gian ngắn.

API Công ty

Điểm cuối Logo Công ty

GET /api/v1/company/logo

Chi phí: 0 tín dụng / yêu cầu thành công. (MIỄN PHÍ)

Truy xuất logo của một công ty dựa trên URL trang web của nó. Trả lại logo dưới dạng hình ảnh PNG (128x128).

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "website=https://www.stripe.com" \
  "https://nubela.co/api/v1/company/logo" \
  --output logo.png

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CompanyAPIApi(api_client)
    logo_data = api.get_company_logo(website="https://www.stripe.com")

    # Save the logo image
    with open("logo.png", "wb") as f:
        f.write(logo_data)

var NinjaPear = require("ninjapear");
var fs = require("fs");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.CompanyAPIApi();
api.getCompanyLogo("https://www.stripe.com").then(function (data) {
  // Save the logo image
  fs.writeFileSync("logo.png", Buffer.from(data));
});

Phản hồi ví dụ:

Nhị phân hình ảnh PNG thô (Content-Type: image/png).

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`trang web`	Có	URL trang web của công ty đích	`https://www.stripe.com`

Phản hồi

A 200 phản hồi trả lại logo dưới dạng hình ảnh PNG thô với Content-Type: image/png.

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
404	Không	Không tìm thấy logo cho tên miền được cung cấp

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`0`

Điểm cuối Chi tiết Công ty

GET /api/v1/company/details

Chi phí: 3 tín dụng / yêu cầu (cơ sở). Thêm 2 tín dụng khi include_employee_count=true. Thêm 1 tín dụng khi follower_count=include. Thêm 2 tín dụng khi addresses=best-effort-exhaustive. Tổng cộng tối đa: 8 tín dụng. Tín dụng được tính ngay cả khi không tìm thấy dữ liệu.

Truy xuất chi tiết của một công ty dựa trên URL trang web của nó. Trả về siêu dữ liệu công ty bao gồm mô tả, ngành công nghiệp, URL phương tiện truyền thông xã hội, đội lãnh đạo hiện tại, v.v.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "website=https://www.stripe.com" \
  "https://nubela.co/api/v1/company/details"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CompanyAPIApi(api_client)
    details = api.get_company_details(website="https://www.stripe.com")
    print(details)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.CompanyAPIApi();
api.getCompanyDetails("https://www.stripe.com").then(function (data) {
  console.log(data);
});

Phản hồi ví dụ (công ty tư nhân):

{
  "websites": ["https://stripe.com", "https://stripe.dev"],
  "description": "Stripe is a technology company that builds economic infrastructure for the internet.",
  "industry": 45102010,
  "company_type": "PRIVATELY_HELD",
  "founded_year": 2010,
  "specialties": ["Payments", "Financial Services", "APIs"],
  "name": "Stripe",
  "tagline": "Financial infrastructure for the internet",
  "logo_url": "https://nubela.co/api/v1/company/logo?website=https://stripe.com",
  "cover_pic_url": "https://example.com/stripe-cover.png",
  "facebook_url": "https://facebook.com/stripe",
  "twitter_url": "https://twitter.com/stripe",
  "instagram_url": null,
  "employee_count": 8000,
  "addresses": [
    {
      "address_type": "HEADQUARTERS",
      "line1": "354 Oyster Point Blvd",
      "line2": null,
      "city": "South San Francisco",
      "state": "CA",
      "postal_code": "94080",
      "country_code": "US",
      "country": "United States",
      "is_primary": true
    }
  ],
  "executives": [
    {
      "name": "Patrick Collison",
      "title": "Chief Executive Officer",
      "role": "CEO",
      "person_profile_url": "https://nubela.co/api/v2/employee/profile?employer_website=https%3A%2F%2Fstripe.com&first_name=Patrick&last_name=Collison"
    }
  ],
  "similar_companies": "https://nubela.co/api/v1/competitor/listing?website=https%3A%2F%2Fstripe.com",
  "updates": "https://nubela.co/api/v1/company/updates?website=https%3A%2F%2Fstripe.com",
  "funding": "https://nubela.co/api/v1/company/funding?website=https%3A%2F%2Fstripe.com",
  "public_listing": null,
  "follower_count": 272190,
  "following_count": 555
}

Phản hồi ví dụ (công ty công khai):

{
  "websites": ["https://apple.com"],
  "description": "Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide.",
  "industry": 45202030,
  "company_type": "PUBLIC_COMPANY",
  "founded_year": 1976,
  "specialties": ["Consumer Electronics", "Software", "Services"],
  "name": "Apple",
  "tagline": "Think different",
  "logo_url": "https://nubela.co/api/v1/company/logo?website=https://apple.com",
  "cover_pic_url": "https://example.com/apple-cover.png",
  "facebook_url": "https://facebook.com/apple",
  "twitter_url": "https://twitter.com/apple",
  "instagram_url": "https://instagram.com/apple",
  "employee_count": 164000,
  "addresses": [
    {
      "address_type": "HEADQUARTERS",
      "line1": "One Apple Park Way",
      "line2": null,
      "city": "Cupertino",
      "state": "CA",
      "postal_code": "95014",
      "country_code": "US",
      "country": "United States",
      "is_primary": true
    }
  ],
  "executives": [
    {
      "name": "Tim Cook",
      "title": "Chief Executive Officer",
      "role": "CEO",
      "person_profile_url": "https://nubela.co/api/v2/employee/profile?employer_website=https%3A%2F%2Fapple.com&first_name=Tim&last_name=Cook"
    }
  ],
  "similar_companies": "https://nubela.co/api/v1/competitor/listing?website=https%3A%2F%2Fapple.com",
  "updates": "https://nubela.co/api/v1/company/updates?website=https%3A%2F%2Fapple.com",
  "funding": "https://nubela.co/api/v1/company/funding?website=https%3A%2F%2Fapple.com",
  "follower_count": 9500000,
  "following_count": 1,
  "public_listing": {
    "stock_symbol": "AAPL",
    "ipo_date": "1980-12-12",
    "isin": "US0378331005",
    "figi": "BBG000B9XRY4",
    "cusip": "037833100",
    "lei": "HWUPKR0MPOU8FGXBT394",
    "cik": "0000320193",
    "sic_code": "3571",
    "revenue_usd": 383285000000,
    "revenue_captured_at": "2024-09-28",
    "ebitda_usd": 134000000000,
    "ebitda_captured_at": "2024-09-28"
  }
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`trang web`	Có	URL trang web hoặc tên công ty của công ty đích. URL trang web (ví dụ: `https://www.stripe.com`) được khuyên dùng mạnh mẽ để đạt độ chính xác.	`https://www.stripe.com`
`include_employee_count`	Không	Tìm nạp dữ liệu số lượng nhân viên mới qua tìm kiếm web. Thêm `2` tín dụng cho chi phí yêu cầu. Giá trị hợp lệ: `true`, `false` (mặc định).	`true`
`follower_count`	Không	Bao gồm số người theo dõi và đang theo dõi Twitter/X. Thêm `1` tín dụng cho chi phí yêu cầu. Các giá trị hợp lệ: `include`. Bỏ qua hoặc chuyển bất kỳ giá trị nào khác để loại trừ.	`include`
`addresses`	Không	Chế độ chi tiết địa chỉ. Mặc định là `hq-only`. Sử dụng `best-effort-exhaustive` để tìm nạp và duy trì các địa chỉ văn phòng vật lý công ty theo nỗ lực tốt nhất trên toàn cầu. Thêm `2` tín dụng cho chi phí yêu cầu.	`best-effort-exhaustive`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (mặc định; sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 29 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-recent`

Phản hồi

Khóa	Mô tả	Ví dụ
`websites`	Danh sách tất cả các URL trang web công ty	`["https://stripe.com", "https://stripe.dev"]`
`description`	Mô tả ngắn về công ty	`"Stripe is a technology company..."`
`industry`	Mã ngành GICS 8 chữ số	`45102010`
`company_type`	Loại công ty (PUBLIC_COMPANY, PRIVATELY_HELD, GOVERNMENT_AGENCY, NON_PROFIT, EDUCATIONAL, PARTNERSHIP, SELF_EMPLOYED, SELF_OWNED)	`"PRIVATELY_HELD"`
`founded_year`	Năm công ty được thành lập	`2010`
`specialties`	Danh sách các chuyên ngành của công ty	`["Payments", "Financial Services"]`
`name`	Tên công ty	`"Stripe"`
`tagline`	Khẩu hiệu hoặc slogan của công ty	`"Financial infrastructure for the internet"`
`logo_url`	Đường dẫn URL đến Điểm cuối logo công ty. Xác thực bằng token bearer khóa API của bạn.	`"https://nubela.co/api/v1/company/logo?website=https://stripe.com"`
`cover_pic_url`	Đường dẫn URL đến hình ảnh bìa/biểu ngữ của công ty	`"https://example.com/cover.png"`
`facebook_url`	URL hồ sơ Facebook	`"https://facebook.com/stripe"`
`twitter_url`	URL hồ sơ Twitter/X	`"https://twitter.com/stripe"`
`instagram_url`	URL hồ sơ Instagram	`null`
`employee_count`	Số lượng nhân viên ước tính	`8000`
`employee_count_range_min`	Giới hạn dưới của phạm vi số lượng nhân viên. Chỉ có khi `include_employee_count=true`.	`7500`
`employee_count_range_max`	Giới hạn trên của khoảng số nhân viên. Chỉ có mặt khi `include_employee_count=true`.	`8500`
`follower_count`	Số lượng người theo dõi Twitter/X. Chỉ có khi `follower_count=include`.	`272190`
`following_count`	Số lượng tài khoản Twitter/X được theo dõi. Chỉ có khi `follower_count=include`.	`555`
`addresses`	Danh sách các địa chỉ công ty. Mặc định chỉ là trụ sở chính trừ khi `addresses=best-effort-exhaustive` được yêu cầu.	[Đối tượng Địa chỉ]
`executives`	Danh sách các giám đốc điều hành và thành viên ban quản lý công ty	[Đối tượng Người Điều hành]
`similar_companies`	Đường dẫn URL đến Điểm cuối danh sách đối thủ cạnh tranh. Xác thực bằng token bearer của bạn để lấy các đối thủ cạnh tranh.	`"https://nubela.co/api/v1/competitor/listing?website=https%3A%2F%2Fstripe.com"`
`updates`	Đường dẫn URL đến Điểm cuối cập nhật công ty. Xác thực bằng token bearer của bạn để lấy cập nhật.	`"https://nubela.co/api/v1/company/updates?website=https%3A%2F%2Fstripe.com"`
`funding`	Đường dẫn URL đến Điểm cuối vốn đầu tư công ty. Xác thực bằng token bearer của bạn để lấy lịch sử vốn đầu tư.	`"https://nubela.co/api/v1/company/funding?website=https%3A%2F%2Fstripe.com"`
`public_listing`	Dữ liệu công ty công cộng bao gồm thông tin cổ phiếu và tài chính. `null` cho các công ty tư nhân.	Đối tượng PublicListing

Đối tượng Địa chỉ

Khóa	Mô tả	Ví dụ
`address_type`	Loại địa chỉ (HEADQUARTERS, REGISTERED, BRANCH, MAILING, OTHER)	`"HEADQUARTERS"`
`line1`	Dòng địa chỉ đường phố 1	`"354 Oyster Point Blvd"`
`line2`	Dòng địa chỉ đường phố 2	`null`
`city`	Tên thành phố	`"South San Francisco"`
`state`	Tiểu bang, tỉnh hoặc vùng	`"CA"`
`postal_code`	Mã bưu điện/ZIP	`"94080"`
`country_code`	Mã quốc gia ISO 3166-1 alpha-2	`"US"`
`country`	Tên đầy đủ của quốc gia	`"United States"`
`is_primary`	Liệu đây có phải là địa chỉ chính	`true`

Đối tượng Người Điều hành

Khóa	Mô tả	Ví dụ
`name`	Tên đầy đủ của giám đốc điều hành	`"Patrick Collison"`
`title`	Chức danh công việc	`"Chief Executive Officer"`
`role`	Loại vai trò được chuẩn hóa (CEO, CFO, COO, CTO, CMO, PRESIDENT, VICE_PRESIDENT, DIRECTOR, BOARD_MEMBER, CHAIRMAN, FOUNDER, OTHER)	`"CEO"`
`person_profile_url`	URL được điền sẵn để Điểm cuối hồ sơ người. Xác thực bằng token bearer của bạn để lấy hồ sơ của nhân viên điều hành. `null` khi tên hoặc trang web công ty bị thiếu.	`"https://nubela.co/api/v2/employee/profile?employer_website=https%3A%2F%2Fstripe.com&first_name=Patrick&last_name=Collison"`

Đối tượng PublicListing

Đối tượng này chỉ có mặt (non-null) cho các công ty công cộng. Đối với các công ty tư nhân, public_listing sẽ là null.

Khóa	Mô tả	Ví dụ
`stock_symbol`	Ký hiệu nhãn chứng khoán	`"AAPL"`
`ipo_date`	Ngày IPO theo định dạng ISO	`"1980-12-12"`
`isin`	Số nhận dạng chứng khoán quốc tế	`"US0378331005"`
`figi`	Financial Instrument Global Identifier	`"BBG000B9XRY4"`
`cusip`	CUSIP identifier	`"037833100"`
`lei`	Mã định danh pháp nhân	`"HWUPKR0MPOU8FGXBT394"`
`cik`	SEC Central Index Key	`"0000320193"`
`sic_code`	SEC Standard Industrial Classification code	`"3571"`
`revenue_usd`	Doanh thu hàng năm bằng USD	`383285000000`
`revenue_captured_at`	Ngày dữ liệu doanh thu được thu thập (định dạng ISO)	`"2024-09-28"`
`ebitda_usd`	EBITDA tính bằng USD	`134000000000`
`ebitda_captured_at`	Ngày dữ liệu EBITDA được thu thập (định dạng ISO)	`"2024-09-28"`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`2`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`12`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Không thể truy cập website
404	Không	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`
404	Có	Không thể trích xuất dữ liệu công ty từ trang web

Điểm cuối Số lượng Nhân viên

GET /api/v1/company/employee-count

Chi phí: 2 tín dụng / yêu cầu thành công.

Truy xuất phạm vi số lượng nhân viên của một công ty dựa trên URL trang web của nó.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "website=https://www.stripe.com" \
  "https://nubela.co/api/v1/company/employee-count"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CompanyAPIApi(api_client)
    response = api.get_employee_count(website="https://www.stripe.com")
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.CompanyAPIApi();
api.getEmployeeCount("https://www.stripe.com").then(function (data) {
  console.log(data);
});

Phản hồi ví dụ:

{
  "employee_count": 3500
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`trang web`	Có	URL trang web hoặc tên công ty của công ty đích. URL trang web (ví dụ: `https://www.stripe.com`) được khuyên dùng mạnh mẽ để đạt độ chính xác.	`https://www.stripe.com`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (mặc định; sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 29 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-recent`

Phản hồi

Khóa	Mô tả	Ví dụ
`employee_count`	Số lượng nhân viên ước tính	`3500`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`2`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`12`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
404	Không	Không tìm thấy dữ liệu số nhân viên cho trang web được cung cấp
404	Không	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`

Điểm cuối Cập nhật Công ty

GET /api/v1/company/updates

Chi phí: 2 tín dụng / yêu cầu.

Truy xuất các bài viết blog và cập nhật X/Twitter mới nhất cho một công ty. Trả lại một dòng thời gian hỗn hợp của các bài đăng blog và X gần đây được sắp xếp theo dấu thời gian.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "website=https://www.stripe.com" \
  "https://nubela.co/api/v1/company/updates"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CompanyAPIApi(api_client)
    response = api.get_company_updates(website="https://www.stripe.com")
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.CompanyAPIApi();
api.getCompanyUpdates("https://www.stripe.com").then(function (data) {
  console.log(data);
});

Phản hồi ví dụ

{
  "blogs": ["https://stripe.com/blog/feed.rss"],
  "x_profile": "https://x.com/stripe",
  "youtube_channels": ["https://www.youtube.com/channel/UCdog0Ap82jpFvSnxorxF_lA"],
  "updates": [
    {
      "url": "https://stripe.com/blog/annual-letter-2024",
      "title": "Stripe's annual letter",
      "description": "A look back at what we built in 2024 and what's ahead.",
      "image_url": null,
      "timestamp": "2025-03-01T12:00:00+00:00",
      "source": "blog"
    },
    {
      "url": "https://x.com/stripe/status/1234567890",
      "title": "We just launched a new feature...",
      "description": "We just launched a new feature that makes payments even easier. Check it out!",
      "image_url": "https://pbs.twimg.com/media/example.jpg",
      "timestamp": "2025-02-28T18:30:00+00:00",
      "source": "x"
    },
    {
      "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
      "title": "How Stripe scales payments",
      "description": "A deep dive into the infrastructure behind Stripe payments.",
      "image_url": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg",
      "timestamp": "2025-02-20T09:00:00+00:00",
      "source": "youtube"
    }
  ],
  "timestamp": "2025-03-16T10:00:00+00:00"
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`trang web`	Có	URL trang web hoặc tên công ty của công ty đích. URL trang web (ví dụ: `https://www.stripe.com`) được khuyên dùng mạnh mẽ để đạt độ chính xác.	`https://www.stripe.com`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (mặc định; sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 1 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-recent`

Phản hồi

Khóa	Mô tả	Ví dụ
`blogs`	Danh sách các URL nguồn cấp RSS blog (nếu RSS được phát hiện) hoặc các URL trang blog	`["https://stripe.com/blog/feed.rss"]`
`x_profile`	URL hồ sơ X/Twitter, hoặc `null` nếu không tìm thấy	`"https://x.com/stripe"`
`youtube_channels`	Danh sách các URL kênh YouTube được phát hiện cho công ty, hoặc để trống nếu không tìm thấy	`["https://www.youtube.com/channel/UCdog0Ap82jpFvSnxorxF_lA"]`
`updates`	Danh sách các đối tượng cập nhật (bài đăng blog, tweet và video YouTube hỗn hợp), được sắp xếp theo dấu thời gian giảm dần.	Xem Cập nhật Đối tượng
`timestamp`	Dấu thời gian UTC khi dữ liệu này được lấy	`"2025-03-16T10:00:00+00:00"`

Cập nhật Đối tượng

Khóa	Mô tả	Ví dụ
`url`	URL của bài đăng trên blog, tweet hoặc video YouTube	`"https://stripe.com/blog/example"`
`title`	Tiêu đề bài đăng (80 ký tự đầu tiên cho tweet)	`"Stripe's annual letter"`
`description`	Mô tả bài viết, nội dung tweet hoặc mô tả video (tối đa 500 ký tự cho blog)	`"A look back at..."`
`image_url`	URL hình ảnh (phương tiện tweet hoặc hình thu nhỏ video), hoặc `null`	`"https://pbs.twimg.com/media/example.jpg"`
`timestamp`	Dấu thời gian xuất bản ISO 8601, hoặc `null` nếu không xác định	`"2025-03-01T12:00:00+00:00"`
`source`	Loại nguồn của bản cập nhật	`"blog"`, `"x"`, hoặc `"youtube"`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`2`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`1`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Thiếu hoặc không hợp lệ tham số trang web
403	Không	Tín dụng không đủ
404	Không	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`

Điểm cuối Vốn đầu tư Công ty

GET /api/v1/company/funding

Chi phí: 2 tín dụng / yêu cầu (cơ sở) + 1 tín dụng cho mỗi nhà đầu tư duy nhất được trả về. Phí cơ sở vẫn áp dụng khi không tìm thấy dữ liệu vốn đầu tư (xem error_code: "no_funding_data" dưới đây).

Truy xuất lịch sử vốn đầu tư của một công ty dựa trên URL trang web của nó. Trả về tổng số tiền gây quỹ, các vòng vốn đầu tư riêng lẻ với ngày tháng và số tiền, cũng như các nhà đầu tư tham gia kèm theo trang web của họ.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --max-time 300 \
  --data-urlencode "website=https://www.stripe.com" \
  "https://nubela.co/api/v1/company/funding"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CompanyAPIApi(api_client)
    # Set a generous read timeout — calls can take up to 5 minutes.
    response = api.get_company_funding(website="https://www.stripe.com", _request_timeout=300)
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";
defaultClient.timeout = 300000; // 5 minutes

var api = new NinjaPear.CompanyAPIApi();
api.getCompanyFunding("https://www.stripe.com").then(function (data) {
  console.log(data);
});

Phản hồi ví dụ

{
  "website": "stripe.com",
  "total_funds_raised_usd": 9810000000,
  "credit_cost": 7,
  "funding_rounds": [
    {
      "round_type": "SECONDARY_SALE",
      "date": "2026-02-01",
      "amount_usd": null,
      "investors": [
        {
          "name": "Thrive Capital",
          "website": "thrivecap.com",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Coatue",
          "website": "coatue.com",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Andreessen Horowitz",
          "website": "a16z.com",
          "type": "company",
          "amount_usd": null
        }
      ]
    },
    {
      "round_type": "SERIES_I",
      "date": "2024-04-01",
      "amount_usd": 694200000,
      "investors": [
        {
          "name": "Sequoia Capital",
          "website": "sequoiacap.com",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Brookfield",
          "website": "brookfield.com",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Paradigm",
          "website": "paradigm.co",
          "type": "company",
          "amount_usd": null
        }
      ]
    },
    {
      "round_type": "SERIES_I",
      "date": "2023-03-01",
      "amount_usd": 6500000000,
      "investors": [
        {
          "name": "GIC",
          "website": "gic.com.sg",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Goldman Sachs",
          "website": "goldmansachs.com",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Temasek",
          "website": "temasek.com.sg",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Thrive Capital",
          "website": "thrivecap.com",
          "type": "company",
          "amount_usd": null
        }
      ]
    },
    {
      "round_type": "SERIES_H",
      "date": "2021-03-01",
      "amount_usd": 600000000,
      "investors": [
        {
          "name": "Allianz X",
          "website": "allianzx.com",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Fidelity",
          "website": "fidelity.com",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Baillie Gifford",
          "website": "bailliegifford.com",
          "type": "company",
          "amount_usd": null
        }
      ]
    },
    {
      "round_type": "SEED",
      "date": "2011-03-01",
      "amount_usd": 2000000,
      "investors": [
        {
          "name": "Peter Thiel",
          "website": null,
          "type": "angel",
          "amount_usd": null
        },
        {
          "name": "Sequoia Capital",
          "website": "sequoiacap.com",
          "type": "company",
          "amount_usd": null
        },
        {
          "name": "Elon Musk",
          "website": null,
          "type": "angel",
          "amount_usd": null
        }
      ]
    }
  ]
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`trang web`	Có	URL trang web hoặc tên công ty của công ty đích. URL trang web (ví dụ: `https://www.stripe.com`) được khuyên dùng mạnh mẽ để đạt độ chính xác.	`https://www.stripe.com`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (mặc định; sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 29 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-recent`

Phản hồi

Khóa	Mô tả	Ví dụ
`trang web`	Tên miền công ty mà phản hồi mô tả, được lặp lại từ yêu cầu	`"stripe.com"`
`total_funds_raised_usd`	Tổng vốn huy động tính bằng USD, hoặc `null` nếu không công khai	`9810000000`
`funding_rounds`	Mảng các đối tượng FundingRound, được sắp xếp theo ngày giảm dần	Xem bên dưới
`credit_cost`	Tổng tín dụng được tính phí cho cuộc gọi này (`2` cơ sở + `1` trên mỗi nhà đầu tư độc nhất). Phản hồi trực tuyến cung cấp chi phí tín dụng trong phần thân phản hồi thay vì `X-NinjaPear-Credit-Cost` tiêu đề.	`7`

FundingRound Object

Khóa	Mô tả	Ví dụ
`round_type`	Loại vòng tài trợ (xem giá trị loại vòng bên dưới)	`"SERIES_A"`
`date`	Ngày của vòng trong `YYYY-MM-DD` định dạng, hoặc `null` nếu không xác định	`"2023-03-01"`
`amount_usd`	Số tiền huy động trong vòng này bằng USD, hoặc `null` nếu không công khai	`600000000`
`investors`	Mảng các đối tượng Investor đã tham gia vòng này	Xem bên dưới

Investor Object

Khóa	Mô tả	Ví dụ
`name`	Tên nhà đầu tư (công ty hoặc cá nhân)	`"Sequoia Capital"`
`trang web`	Tên miền của nhà đầu tư, hoặc `null` nếu không xác định	`"sequoiacap.com"`
`type`	Hoặc `"company"` (VC firm, quỹ, công ty) hoặc `"angel"` (cá nhân)	`"company"`
`amount_usd`	Số tiền nhà đầu tư này đóng góp bằng USD, hoặc `null` nếu không công khai	`null`

Các Giá Trị Loại Vòng

PRE_SEED, SEED, SERIES_A, SERIES_B, SERIES_C, SERIES_D, SERIES_E, SERIES_F, SERIES_G, SERIES_H, SERIES_I thông qua SERIES_Z, BRIDGE, VENTURE_DEBT, CONVERTIBLE_NOTE, GRANT, SECONDARY_SALE, PRIVATE_EQUITY, GROWTH_EQUITY, IPO, POST_IPO_EQUITY, POST_IPO_DEBT, DEBT_FINANCING, CROWDFUNDING, CORPORATE_ROUND, UNKNOWN

Tiêu đề Phản hồi

Điểm cuối này phát trực tuyến phản hồi của nó; HTTP trailers không được hỗ trợ, vì vậy chi phí tín dụng được cung cấp trong thân phản hồi (cái credit_cost trường) thay vì X-NinjaPear-Credit-Cost tiêu đề. Khi phản hồi được cung cấp từ bộ nhớ cache, X-NinjaPear-Credit-Cost tiêu đề được trả về bình thường. X-NinjaPear-Cache-Age-Days tiêu đề được trả về trên các phản hồi thành công cho tất cả use_cache chế độ; làm giàu dữ liệu trực tiếp mới trả về 0.

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này (2 cơ sở + 1 cho mỗi nhà đầu tư). Chỉ các lần hit bộ nhớ cache.	`7`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`12`

Mã lỗi

Lỗi phía máy khách (HTTP 400 / 403) được trả về trước khi nội dung truyền phát bắt đầu. Khi không có trong bộ nhớ cache, lỗi phía máy chủ được gửi dưới dạng HTTP 200 với error và error_code trường trong phần thân phản hồi — vì kết nối streaming đã được thiết lập, mã trạng thái không thể thay đổi. Khách hàng đã phân nhánh dựa trên response.status_code == 404 nên nhánh dựa trên error_code trường thay vào đó.

Mã Trạng Thái	Được tính phí?	`error_code` (body)	Mô tả
400	Không	—	Thiếu hoặc không hợp lệ tham số trang web
403	Không	—	Tín dụng không đủ
404	Không	—	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`
200 (phần thân chứa lỗi)	Có (2 tín dụng)	`no_funding_data`	Không tìm thấy dữ liệu vốn đầu tư cho trang web được cung cấp. `funding_rounds` là `[]`.
200 (phần thân chứa lỗi)	Không	`service_temp_unavailable`	Dịch vụ tạm thời không khả dụng. Hãy thử lại sau. `funding_rounds` là `[]`.

Điểm cuối Tra cứu Trang web

GET /api/v1/company/website

Chi phí: 1 tín dụng / yêu cầu (được tính phí bất kể có tìm thấy kết quả phù hợp hay không).

Phân giải tên công ty thành URL trang web chính tắc của nó.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "company_name=Apex" \
  --data-urlencode "country_code=us" \
  --data-urlencode "hint=cybersecurity firm" \
  "https://nubela.co/api/v1/company/website"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.CompanyAPIApi(api_client)
    response = api.get_website_lookup(
        company_name="Apex",
        country_code="us",
        hint="cybersecurity firm",
    )
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.CompanyAPIApi();
api.getWebsiteLookup("Apex", {
  countryCode: "us",
  hint: "cybersecurity firm",
}).then(function (data) {
  console.log(data);
});

Phản hồi ví dụ:

{
  "website": "https://www.apexsecurity.com"
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`company_name`	Có	Tên của công ty để tra cứu.	`Apex`
`country_code`	Không	Mã quốc gia ISO 3166-1 alpha-2 có hai chữ cái tùy chọn được sử dụng để thiên vị tìm kiếm theo địa lý (ví dụ `us`, `gb`, `de`, `sg`). Xem danh sách đầy đủ các mã ISO 3166-1 alpha-2. Mặc định là `us` khi được bỏ qua.	`us`
`gợi ý`	Không	Cung cấp gợi ý để phân biệt các công ty có tên tương tự ở cùng một quốc gia.	`cybersecurity firm`

Phản hồi

Khóa	Mô tả	Ví dụ
`trang web`	URL trang web chính thức đã được xác định.	`https://www.stripe.com`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`1`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Thiếu hoặc không hợp lệ `company_name` tham số.
400	Không	Không hợp lệ `country_code` (không phải mã 2 ký tự được công nhận).
404	Có (1)	Không tìm thấy kết quả phù hợp với tên công ty được cung cấp.

API Nhân viên

Điểm cuối Email Công Việc

GET /api/v1/employee/work-email

Chi phí: 2 tín dụng trên một tra cứu thành công (email công việc tìm thấy). Khi không tìm thấy email (work_email là null), một khoản phí token là 0.5 tín dụng được áp dụng — điều này ngăn chặn lạm dụng trong khi giữ cho các tra cứu suy đoán có giá rẻ.

Cố gắng tốt nhất để trả về một email công việc công khai của một người với tên đầu tiên (tên cuối cùng tùy chọn) và tên miền công ty.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "first_name=Patrick" \
  --data-urlencode "last_name=Collison" \
  --data-urlencode "domain=stripe.com" \
  "https://nubela.co/api/v1/employee/work-email"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.EmployeeAPIApi(api_client)
    result = api.find_work_email(
        first_name="Patrick",
        last_name="Collison",
        domain="stripe.com",
    )
    print(result)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.EmployeeAPIApi();
api
  .findWorkEmail({
    firstName: "Patrick",
    lastName: "Collison",
    domain: "stripe.com",
  })
  .then(function (data) {
    console.log(data);
  });

Phản hồi ví dụ (email được tìm thấy)

{
  "work_email": "[email protected]"
}

Phản hồi ví dụ (không có bằng chứng)

{
  "work_email": null
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`first_name`	Có	Tên của người.	`Patrick`
`last_name`	Không	Họ của người. Cải thiện độ chính xác khi mẫu cần nó.	`Collison`
`domain`	Có	Tên miền công ty. Giao thức và đường dẫn sẽ bị loại bỏ nếu có.	`stripe.com`

Phản hồi

Khóa	Mô tả	Ví dụ
`work_email`	Địa chỉ email công việc nỗ lực tốt nhất. `null` nếu không tìm thấy email công khai VÀ không thể suy ra được mẫu nào.	`"[email protected]"` \| `null`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng tín dụng được tính phí cho cuộc gọi này. `2` khi tìm thấy; `0.5` khi không tìm thấy (phí chống lạm dụng tín dụng).	`2` hoặc `0.5`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Thiếu hoặc không hợp lệ `first_name` / `domain`.
403	Không	Tín dụng không đủ.
503	Không	Dịch vụ tạm thời không khả dụng. Hãy thử lại sau.

Điểm cuối Hồ sơ Người

GET /api/v2/employee/profile

Chi phí: 3 tín dụng / yêu cầu. Tín dụng được tính ngay cả khi không tìm thấy dữ liệu.

Làm giàu dữ liệu hồ sơ chuyên nghiệp của nhân viên với địa chỉ email công việc, kết hợp tên và nhà tuyển dụng, hoặc kết hợp vai trò và nhà tuyển dụng. Trả về dữ liệu hồ sơ được cấu trúc bao gồm lịch sử công việc, giáo dục, vị trí và sự hiện diện trên phương tiện truyền thông xã hội.

Bạn phải cung cấp ít nhất một trong những tổ hợp đầu vào này:

Chỉ email công việc — ví dụ [email protected]
Tên + website nhà tuyển dụng — ví dụ first_name=John&employer_website=https://stripe.com
Website nhà tuyển dụng + vai trò — ví dụ employer_website=https://stripe.com&role=CTO

Bạn luôn có thể thêm nhiều tham số hơn để cải thiện độ chính xác. Ví dụ, cung cấp work_email cùng với first_name, last_name, và role sẽ mang lại kết quả tốt hơn so với work_email một mình.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "[email protected]" \
  "https://nubela.co/api/v2/employee/profile"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.EmployeeAPIApi(api_client)
    profile = api.get_person_profile_v2(work_email="[email protected]")
    print(profile)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.EmployeeAPIApi();
api.getPersonProfileV2({ workEmail: "[email protected]" }).then(function (data) {
  console.log(data);
});

Phản hồi ví dụ

{
  "id": "abc123de-f456-7890-abcd-ef1234567890",
  "slug": "elon-musk",
  "profile_pic_url": "https://pbs.twimg.com/profile_images/1234567890/photo_400x400.jpg",
  "first_name": "Elon",
  "middle_name": "Reeve",
  "last_name": "Musk",
  "full_name": "Elon Reeve Musk",
  "bio": "Mars & Cars, Chips & Dips",
  "follower_count": 195000000,
  "following_count": 782,
  "country": "US",
  "city": "USAUS",
  "state": "US-TX",
  "x_handle": "elonmusk",
  "x_profile_url": "https://x.com/elonmusk",
  "personal_website": "https://elonmusk.com",
  "work_experience": [
    {
      "role": "CEO",
      "company_name": "Tesla",
      "company_website": "tesla.com",
      "description": "Leading Tesla's mission to accelerate the world's transition to sustainable energy.",
      "start_date": "2008-10",
      "end_date": null
    },
    {
      "role": "CEO and CTO",
      "company_name": "SpaceX",
      "company_website": "spacex.com",
      "description": "Founded SpaceX with the goal of reducing space transportation costs and enabling the colonization of Mars.",
      "start_date": "2002-05",
      "end_date": null
    },
    {
      "role": "Co-founder",
      "company_name": "PayPal",
      "company_website": "paypal.com",
      "description": null,
      "start_date": "1999-01",
      "end_date": "2002-10"
    }
  ],
  "education": [
    {
      "major": "B.S. Economics",
      "school": "Wharton School, University of Pennsylvania",
      "start_date": "1992-01",
      "end_date": "1997-01"
    },
    {
      "major": "B.S. Physics",
      "school": "University of Pennsylvania",
      "start_date": "1992-01",
      "end_date": "1997-01"
    }
  ],
  "work_email_lookup": "https://nubela.co/api/v1/employee/work-email?first_name=Elon&last_name=Musk&domain=tesla.com",
  "similar_people": "https://nubela.co/api/v1/employee/similar?id=abc123de-f456-7890-abcd-ef1234567890"
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`work_email`	Điều kiện	Địa chỉ email công việc của người. Bắt buộc nếu `employer_website` không được cung cấp.	`[email protected]`
`first_name`	Điều kiện	Tên của người. Bắt buộc khi sử dụng name +. `employer_website` kết hợp.	`John`
`middle_name`	Không	Tên đệm của người. Cải thiện độ chính xác khi kết hợp với các tham số khác.	`Michael`
`last_name`	Không	Họ của người. Cải thiện độ chính xác khi kết hợp với các tham số khác.	`Smith`
`employer_website`	Điều kiện	URL website hoặc tên công ty nơi người đó làm việc. Khuyến khích sử dụng URL website để đảm bảo độ chính xác. Bắt buộc nếu `work_email` không được cung cấp.	`https://stripe.com`
`role`	Không	Chức danh hoặc vai trò công việc hiện tại. Cải thiện độ chính xác. Bắt buộc khi sử dụng `employer_website` không có tên.	`CTO`
`slug`	Không	Slug người để tra cứu trực tiếp một hồ sơ được làm giàu dữ liệu hiện có.	`elon-musk`
`id`	Không	ID người để tra cứu trực tiếp một hồ sơ được làm giàu dữ liệu hiện có.	`abc123de-...`
`enrichment`	Không	Kiểm soát độ sâu làm giàu dữ liệu trực tiếp. Giá trị: `fast` (mặc định; trả về nhanh chóng và bắt đầu làm giàu dữ liệu chi tiết trong nền), `detailed` (chờ đợi làm giàu dữ liệu chi tiết trước khi trả về). Phản hồi nhanh bao gồm ít chi tiết tiểu sử hơn, chẳng hạn như dữ liệu trang web và ảnh hồ sơ, nhưng nhanh chóng trả về lịch sử công việc và giáo dục được cấu trúc. Một yêu cầu làm giàu dữ liệu nhanh cũng khởi động quá trình làm giàu dữ liệu chi tiết trong nền, và bạn cũng có quyền nhận kết quả đó. Yêu cầu lại với các tham số giống nhau và `use_cache=if-recent` 10 đến 30 giây sau để lấy kết quả được làm giàu dữ liệu đầy đủ mà không có chi phí bổ sung. Dừng lấy dữ liệu khi `X-NinjaPear-Enrichment-Status` tiêu đề phản hồi là `complete`. Sau khi làm giàu dữ liệu chi tiết hoàn thành, yêu cầu tương tự trả về hồ sơ được lưu trong bộ nhớ cache chi tiết mà không có chi phí bổ sung. Sử dụng `enrichment=fast` khi bạn cần kết quả nhanh chóng cho các trường hợp sử dụng như điền dữ liệu vào UI. Sử dụng `enrichment=detailed` khi bạn cần phản hồi đầy đủ và không vấn đề với việc chờ đợi.	`fast`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (mặc định; sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 29 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-recent`

Các kết hợp đầu vào hợp lệ

Kết hợp	Ví dụ
`work_email` một mình	`[email protected]`
`first_name` + `employer_website`	`?first_name=John&employer_website=https://stripe.com`
`employer_website` + `role`	`?employer_website=https://stripe.com&role=CTO`
`slug` hoặc `id`	`?slug=elon-musk`

Luôn có thể bao gồm các tham số bổ sung để cải thiện độ chính xác của kết quả.

Phản hồi

Khóa	Mô tả	Ví dụ
`id`	Mã định danh người duy nhất. Có mặt khi hồ sơ được hỗ trợ bởi bản ghi người được lưu giữ.	`"abc123de-f456-7890-abcd-ef1234567890"`
`slug`	Slug người duy nhất. Có mặt khi hồ sơ được hỗ trợ bởi bản ghi người được lưu giữ.	`"elon-musk"`
`profile_pic_url`	Đường dẫn URL đến ảnh hồ sơ của người (từ X/Twitter). Có thể là `null`.	`"https://pbs.twimg.com/.../photo_400x400.jpg"`
`first_name`	Tên	`"Elon"`
`middle_name`	Tên đệm. Có thể là `null`.	`"Reeve"`
`last_name`	Họ	`"Musk"`
`full_name`	Tên đầy đủ	`"Elon Reeve Musk"`
`bio`	Tiểu sử/mô tả từ hồ sơ X/Twitter. Có thể là `null`.	`"Mars & Cars, Chips & Dips"`
`follower_count`	Số lượng người theo dõi X/Twitter. Có thể `null`.	`195000000`
`following_count`	Số lượng tài khoản X/Twitter được theo dõi. Có thể `null`.	`782`
`country`	Quốc gia cư trú. Mã ISO 3166-1 alpha-2.	`"US"`
`city`	Thành phố cư trú. UN/LOCODE.	`"USAUS"`
`state`	Tiểu bang hoặc vùng cư trú. Mã phân chia ISO 3166-2.	`"US-TX"`
`x_handle`	Tên người dùng X/Twitter (không có @). Có thể là `null`.	`"elonmusk"`
`x_profile_url`	URL đến hồ sơ X/Twitter. Có thể là `null`.	`"https://x.com/elonmusk"`
`personal_website`	URL trang web cá nhân. Có thể là `null`.	`"https://elonmusk.com"`
`work_experience`	Danh sách các mục lịch sử công việc, gần đây nhất trước tiên	[Đối Tượng WorkExperience]
`education`	Danh sách các mục giáo dục, gần đây nhất trước tiên	[Đối tượng Giáo dục]
`work_email_lookup`	URL được tạo sẵn để Điểm cuối Email Công Việc cho người này, với `first_name`, `last_name`, và `domain` (trang web của trải nghiệm công việc gần đây nhất) đã được điền sẵn. Gọi nó trực tiếp với mã bearer token của bạn để xác định email công việc của người - không cần phải cung cấp lại params. Chi phí `2` tín dụng mỗi cuộc gọi. Có thể là `null` khi trang web của nhà tuyển dụng hiện tại không rõ.	`"https://nubela.co/api/v1/employee/work-email?first_name=Elon&last_name=Musk&domain=tesla.com"`
`similar_people`	URL được tạo sẵn để Điểm cuối Những Người Tương Tự cho người này, được khóa bởi `id`. Gọi nó trực tiếp để lấy những người có cùng vai trò ở các công ty cạnh tranh — không cần phải truyền lại các tham số tìm kiếm.	`"https://nubela.co/api/v1/employee/similar?id=abc123de-..."`

Đối Tượng WorkExperience

Khóa	Mô tả	Ví dụ
`role`	Chức danh công việc hoặc vị trí	`"CEO"`
`company_name`	Tên công ty	`"Tesla"`
`company_website`	Tên miền trang web công ty. Có thể là `null`.	`"tesla.com"`
`description`	Mô tả những gì người đó đã làm trong vai trò này. Có thể là `null`.	`"Leading Tesla's mission..."`
`start_date`	Ngày bắt đầu theo định dạng YYYY-MM. Có thể là `null`.	`"2008-10"`
`end_date`	Ngày kết thúc ở định dạng YYYY-MM. `null` có nghĩa là hiện đang ở vai trò này.	`null`

Đối tượng Giáo dục

Khóa	Mô tả	Ví dụ
`major`	Bằng cấp và lĩnh vực học tập	`"B.S. Economics"`
`school`	Tên trường học hoặc đại học	`"Wharton School, University of Pennsylvania"`
`start_date`	Ngày bắt đầu theo định dạng YYYY-MM. Có thể là `null`.	`"1992-01"`
`end_date`	Ngày kết thúc ở định dạng YYYY-MM. Có thể là `null`.	`"1997-01"`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`3`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`12`
`X-NinjaPear-Enrichment-Status`	Trạng thái làm giàu dữ liệu chi tiết cho các phản hồi Hồ sơ Người dùng v2. `pending` có nghĩa là phản hồi là hồ sơ nhanh và việc làm giàu dữ liệu chi tiết vẫn đang chạy hoặc chờ hoàn thành. `complete` có nghĩa là phản hồi là hồ sơ chi tiết trong cache hoặc một `enrichment=detailed` kết quả. Kiểm tra cho đến khi tiêu đề này là `complete`.	`complete`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Đầu vào không hợp lệ. Phải cung cấp `work_email`, hoặc `first_name` + `employer_website`, hoặc `employer_website` + `role`.
400	Không	Không hợp lệ `enrichment`. Sử dụng `fast` hoặc `detailed`. Cái đã lỗi thời `speed` tham số không được chấp nhận.
400	Không	`work_email` là một email cá nhân/miễn phí (ví dụ `[email protected]`). Cung cấp email công việc của công ty.
403	Không	Tín dụng không đủ
404	Không	`work_email` là một hộp thư dựa trên vai trò / chung chung (ví dụ `info@`, `support@`, `sales@`, `noreply@`) không ánh xạ tới một người cá nhân.
404	Không	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`
404	Có (3 tín dụng)	Không thể tìm thấy dữ liệu hồ sơ cho đầu vào được cung cấp
503	Không	Dịch vụ tạm thời không khả dụng. Hãy thử lại sau.

Điểm cuối Những Người Tương Tự

GET /api/v1/employee/similar

Chi phí: 10 tín dụng cơ sở + 5 tín dụng cho mỗi tuple (công ty, vai trò) được thử. Chi phí cơ bản được tính bất kể có tìm thấy bất kỳ người tương tự nào, vì điểm cuối sử dụng các tài nguyên làm giàu dữ liệu thời gian thực để hoàn thành mỗi yêu cầu. Kết quả được lưu trong bộ đệm là miễn phí (xem bên dưới).

Tìm những người là tương tự cho một người mục tiêu — được định nghĩa là những người nắm giữ cùng vai trò tại các công ty cạnh tranh. Cho một mục tiêu (ví dụ: CEO của nubela.co), điểm cuối xác định nhà tuyển dụng hiện tại của mục tiêu, tra cứu các đối thủ cạnh tranh của nhà tuyển dụng đó, và cố gắng làm giàu dữ liệu người có cùng vai trò tại mỗi đối thủ cạnh tranh trong thời gian thực. Phản hồi trả về hồ sơ của mục tiêu, danh sách các tuple (công ty, vai trò) mà chúng tôi đã cố gắng tìm kiếm, và những người tương tự mà chúng tôi đã làm giàu dữ liệu thành công.

Các đầu vào giống hệt với Điểm cuối Hồ sơ Người. Bạn phải cung cấp ít nhất một trong các kết hợp đầu vào này:

Chỉ email công việc — ví dụ [email protected]
Tên + website nhà tuyển dụng — ví dụ first_name=Tim&employer_website=https://apple.com
Website nhà tuyển dụng + vai trò — ví dụ employer_website=https://apple.com&role=CEO

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --max-time 300 \
  --data-urlencode "[email protected]" \
  "https://nubela.co/api/v1/employee/similar"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.EmployeeAPIApi(api_client)
    # Set a generous read timeout — calls can take up to 5 minutes.
    result = api.get_similar_people(work_email="[email protected]", _request_timeout=300)
    print(result)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";
defaultClient.timeout = 300000; // 5 minutes

var api = new NinjaPear.EmployeeAPIApi();
api.getSimilarPeople({ workEmail: "[email protected]" }).then(function (data) {
  console.log(data);
});

Phản hồi ví dụ

{
  "target": {
    "first_name": "Tim",
    "last_name": "Cook",
    "full_name": "Tim Cook",
    "work_experience": [
      {
        "role": "CEO",
        "company_name": "Apple",
        "company_website": "apple.com",
        "start_date": "2011-08",
        "end_date": null
      }
    ]
  },
  "attempted_searches": [
    { "employer_website": "samsung.com", "role": "CEO" },
    { "employer_website": "google.com", "role": "CEO" },
    { "employer_website": "microsoft.com", "role": "CEO" },
    { "employer_website": "huawei.com", "role": "CEO" }
  ],
  "similar_people": [
    {
      "first_name": "Sundar",
      "last_name": "Pichai",
      "full_name": "Sundar Pichai",
      "work_experience": [
        {
          "role": "CEO",
          "company_name": "Google",
          "company_website": "google.com",
          "start_date": "2015-08",
          "end_date": null
        }
      ]
    },
    {
      "first_name": "Satya",
      "last_name": "Nadella",
      "full_name": "Satya Nadella",
      "work_experience": [
        {
          "role": "CEO",
          "company_name": "Microsoft",
          "company_website": "microsoft.com",
          "start_date": "2014-02",
          "end_date": null
        }
      ]
    }
  ],
  "credit_cost": 30
}

Để ngắn gọn, ví dụ trên chỉ hiển thị một tập hợp con của PersonProfile trường. Mỗi mục nhập dưới mục tiêu và similar_people là một đầy đủ PersonProfile đối tượng — xem Phản hồi Điểm cuối Hồ sơ Người cho lược đồ hoàn chỉnh, bao gồm profile_pic_url, bio, country, x_handle, education, v.v.

Tham số URL

Giống hệt với Tham số URL Điểm cuối Hồ sơ Người.

Tham số	Bắt buộc	Mô tả	Ví dụ
`work_email`	Điều kiện	Địa chỉ email công việc của người đối tượng. Bắt buộc nếu `employer_website` không được cung cấp.	`[email protected]`
`first_name`	Điều kiện	Tên đầu tiên của mục tiêu. Bắt buộc khi sử dụng name + `employer_website` kết hợp.	`Tim`
`middle_name`	Không	Tên giữa của mục tiêu. Cải thiện độ chính xác khi được kết hợp với các tham số khác.	`Donald`
`last_name`	Không	Tên cuối cùng của mục tiêu. Cải thiện độ chính xác khi được kết hợp với các tham số khác.	`Cook`
`employer_website`	Điều kiện	URL website hoặc tên công ty nơi đối tượng làm việc. Khuyến khích sử dụng URL website để đảm bảo độ chính xác. Bắt buộc nếu `work_email` không được cung cấp.	`https://apple.com`
`role`	Không	Chức danh hoặc vai trò công việc hiện tại. Bắt buộc khi sử dụng `employer_website` không có tên.	`Giám đốc điều hành`

Các kết hợp đầu vào hợp lệ

Kết hợp	Ví dụ
`work_email` một mình	`[email protected]`
`first_name` + `employer_website`	`?first_name=Tim&employer_website=https://apple.com`
`employer_website` + `role`	`?employer_website=https://apple.com&role=CEO`

Phản hồi

Khóa	Mô tả	Ví dụ
`mục tiêu`	Hồ sơ đầy đủ của người đích được xác định. Cùng lược đồ như Điểm cuối Hồ sơ Người.	`{ "first_name": "Tim", ... }`
`attempted_searches`	Danh sách các cặp (công ty, vị trí) mà chúng tôi cố gắng làm giàu dữ liệu. Một mục cho mỗi đối thủ cạnh tranh của nhà tuyển dụng hiện tại của mục tiêu. Xác định mức thanh toán theo từng cặp (5 tín dụng mỗi).	[AttemptedSearch Object]
`similar_people`	Danh sách các hồ sơ được làm giàu dữ liệu thành công cho những người phù hợp với cùng vai trò ở các đối thủ cạnh tranh. Có thể là một tập con của `attempted_searches` (một số nỗ lực không trả về dữ liệu). Mỗi mục nhập sử dụng cùng schema như Điểm cuối Hồ sơ Người.	[PersonProfile, ...]
`credit_cost`	Tổng tín dụng được tính phí cho cuộc gọi này. Bằng với `10 + 5 * len(attempted_searches)`, hoặc `0` cho kết quả được lưu trong bộ đệm được cung cấp cho cùng một sản phẩm đã thanh toán trước đó.	`30`

AttemptedSearch Object

Khóa	Mô tả	Ví dụ
`employer_website`	Tên miền trang web công ty đối thủ cạnh tranh mà chúng tôi đã cố gắng.	`"google.com"`
`role`	Vai trò mà chúng tôi tìm kiếm tại đối thủ cạnh tranh đó (phản ánh mục tiêu).	`"CEO"`

Tiêu đề Phản hồi

Điểm cuối này phát trực tuyến phản hồi của nó, vì vậy chi phí tín dụng không thể được trả về trong tiêu đề — HTTP trailers không được hỗ trợ bởi lớp phát trực tuyến. Đọc credit_cost trường trên phần thân phản hồi thay vì thông thường X-NinjaPear-Credit-Cost tiêu đề.

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Đầu vào không hợp lệ. Phải cung cấp `work_email`, hoặc `first_name` + `employer_website`, hoặc `employer_website` + `role`.
400	Không	`work_email` là một email cá nhân/miễn phí (ví dụ `[email protected]`). Cung cấp email công việc của công ty.
403	Không	Tín dụng không đủ. Bạn cần ít nhất 10 tín dụng để bắt đầu tìm kiếm những người tương tự.
404	Không	`work_email` là một hộp thư dựa trên vai trò / chung chung (ví dụ `info@`, `support@`, `sales@`, `noreply@`) không ánh xạ tới một người cá nhân.
404	Không	Không thể giải quyết người mục tiêu.
503	Không	Tài nguyên tạm thời không có sẵn. Vui lòng thử lại.

Điểm cuối Tìm kiếm Nhân viên

GET /api/v1/employee/search

Chi phí: cơ bản 2 tín dụng mỗi cuộc gọi (được tính ngay cả khi không có nhân viên nào được trả về), cộng thêm 1 tín dụng cho mỗi nhân viên trong nhân viên mảng. Một truy vấn trả về 10 nhân viên chi phí 2 + 10 = 12 tín dụng.

Tìm nhân viên hiện tại của một công ty được lọc theo vai trò, tùy chọn thu hẹp theo địa lý.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "company_website=stripe.com" \
  --data-urlencode "role=VP of Engineering" \
  "https://nubela.co/api/v1/employee/search"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.EmployeeAPIApi(api_client)
    result = api.search_employees(
        company_website="stripe.com",
        role="VP of Engineering",
    )
    print(result)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.EmployeeAPIApi();
api.searchEmployees({
  companyWebsite: "stripe.com",
  role: "VP of Engineering",
}).then(function (data) {
  console.log(data);
});

Phản hồi ví dụ

{
  "employees": [
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "role": "VP of Engineering",
      "company_website": "stripe.com",
      "company_details": "https://nubela.co/api/v1/company/details?website=stripe.com",
      "person_profile": "https://nubela.co/api/v2/employee/profile?first_name=Jane&last_name=Doe&employer_website=https%3A%2F%2Fstripe.com",
      "work_email": "https://nubela.co/api/v1/employee/work-email?first_name=Jane&last_name=Doe&domain=stripe.com"
    },
    {
      "first_name": "John",
      "last_name": "Smith",
      "role": "Director of Engineering",
      "company_website": "stripe.com",
      "company_details": "https://nubela.co/api/v1/company/details?website=stripe.com",
      "person_profile": "https://nubela.co/api/v2/employee/profile?first_name=John&last_name=Smith&employer_website=https%3A%2F%2Fstripe.com",
      "work_email": "https://nubela.co/api/v1/employee/work-email?first_name=John&last_name=Smith&domain=stripe.com"
    }
  ]
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`company_website`	Có	Công ty đích. Hình thức ưa thích là trang web (miền trần như `stripe.com` hoặc đường dẫn URL đầy đủ như `https://stripe.com`). Tên công ty (ví dụ: `Stripe`) cũng được chấp nhận.	`stripe.com`
`role`	Có	Vị trí công việc để thu hẹp tìm kiếm. Khớp với các biến thể vị trí liên quan (ví dụ: `VP Kỹ thuật` cũng khớp với `Vice President, Engineering`).	`VP Kỹ thuật`
`country`	Không	Mã quốc gia ISO 3166-1 alpha-2 để giới hạn.	`US`
`state`	Không	Tiểu bang hoặc vùng để hạn chế (dạng tự do).	`California`
`city`	Không	Thành phố để ràng buộc (dạng tự do).	`San Francisco`
`use_cache`	Không	Kiểm soát việc sử dụng bộ đệm. Không phân biệt chữ hoa chữ thường. Giá trị: `if-recent` (mặc định; sử dụng dữ liệu được lưu trong bộ nhớ đệm khi lần quét cuối cùng trong 29 ngày, nếu không làm giàu dữ liệu trực tiếp), `if-present` (trả về bộ nhớ đệm trước, làm giàu dữ liệu trực tiếp nếu không có), `if-present-only` (chỉ trả về bộ nhớ đệm; trả về 404 nếu không có), `never` (luôn làm giàu dữ liệu trực tiếp). Các giá trị không hợp lệ sẽ sử dụng mặc định của điểm cuối.	`if-recent`

Phản hồi

Khóa	Mô tả	Ví dụ
`nhân viên`	Danh sách nhân viên phù hợp ở công ty mục tiêu. Mảng trống nếu không tìm thấy.	[Đối tượng Nhân viên]

Đối tượng Nhân viên

Khóa	Mô tả	Ví dụ
`first_name`	Tên đầu tiên của nhân viên.	`"Jane"`
`last_name`	Tên cuối cùng của nhân viên. Có thể là `null` nếu không có sẵn.	`"Doe"`
`role`	Chức danh công việc hiện tại của nhân viên tại công ty mục tiêu.	`"VP of Engineering"`
`company_website`	Website của công ty nơi nhân viên làm việc. Phản ánh lại `company_website` tham số đầu vào trên mỗi bản ghi.	`"stripe.com"`
`company_details`	URL được điền sẵn để Điểm cuối Chi tiết Công ty, được điền bằng `trang web`. Xác thực bằng token bearer của bạn để lấy chi tiết công ty.	`"https://nubela.co/api/v1/company/details?website=stripe.com"`
`person_profile`	URL được điền sẵn để Điểm cuối Hồ sơ Người, được điền bằng `first_name`, `last_name`, và `employer_website`. Gọi trực tiếp bằng token bearer của bạn để làm giàu dữ liệu cho người đó. Chi phí `3` tín dụng mỗi cuộc gọi.	`"https://nubela.co/api/v2/employee/profile?first_name=Jane&last_name=Doe&employer_website=https%3A%2F%2Fstripe.com"`
`work_email`	URL được điền sẵn để Điểm cuối Email Công Việc, được điền bằng `first_name`, `last_name`, và `domain`. Gọi trực tiếp bằng token bearer của bạn để phân giải email công việc. Chi phí `2` tín dụng trên một lần trúng, `0.5` tín dụng khi không tìm thấy email.	`"https://nubela.co/api/v1/employee/work-email?first_name=Jane&last_name=Doe&domain=stripe.com"`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng tín dụng được tính phí cho cuộc gọi này. Bằng `2 + N` nơi `N` là số nhân viên được trả về (`2` khi mảng trống).	`12`
`X-NinjaPear-Cache-Age-Days`	Tuổi của dữ liệu được trả về (tính bằng ngày) `0` khi dữ liệu mới được trả về từ làm giàu dữ liệu trực tiếp.	`12`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Thiếu hoặc không hợp lệ `company_website` hoặc `role` tham số.
403	Không	Tín dụng không đủ. Bạn cần ít nhất `2` tín dụng để bắt đầu tìm kiếm.
404	Không	Không tìm thấy dữ liệu được cache khi `use_cache=if-present-only`
404	Không	Cái được cung cấp `company_website` không thể được phân giải thành một công ty đã biết.
503	Không	Tài nguyên tạm thời không có sẵn. Vui lòng thử lại.

Meta API

Xem Điểm cuối Số dư Tín dụng

GET /api/v1/meta/credit-balance

Chi phí: 0 tín dụng / yêu cầu thành công.

Lấy số dư tín dụng hiện tại của bạn.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://nubela.co/api/v1/meta/credit-balance"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.MetaAPIApi(api_client)
    response = api.get_credit_balance()
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.MetaAPIApi();
api.getCreditBalance().then(function (data) {
  console.log(data);
});

Phản hồi ví dụ:

{
  "credit_balance": 100000
}

Phản hồi

Khóa	Mô tả	Ví dụ
`credit_balance`	Số dư tín dụng hiện tại của bạn	`100000`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`0`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
401	Không	API key không hợp lệ

API Liên hệ

Điểm cuối Trình kiểm tra Email Dùng một lần

GET /api/v1/contact/disposable-email

Chi phí: 0 tín dụng / yêu cầu thành công. (MIỄN PHÍ)

Kiểm tra xem địa chỉ email có phải là email dùng một lần (tạm thời/vứt đi) hay nhà cung cấp email miễn phí.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "[email protected]" \
  "https://nubela.co/api/v1/contact/disposable-email"

import ninjapear

configuration = ninjapear.Configuration(
    host="https://nubela.co",
    access_token="YOUR_API_KEY"
)

with ninjapear.ApiClient(configuration) as api_client:
    api = ninjapear.ContactAPIApi(api_client)
    response = api.check_disposable_email(email="[email protected]")
    print(response)

var NinjaPear = require("ninjapear");
var defaultClient = NinjaPear.ApiClient.instance;
defaultClient.authentications["bearerAuth"].accessToken = "YOUR_API_KEY";

var api = new NinjaPear.ContactAPIApi();
api.checkDisposableEmail("[email protected]").then(function (data) {
  console.log(data);
});

Phản hồi ví dụ:

{
  "email": "[email protected]",
  "is_disposable_email": true,
  "is_free_email": false
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`email`	Có	Địa chỉ email để kiểm tra	`[email protected]`

Phản hồi

Khóa	Mô tả	Ví dụ
`email`	Địa chỉ email đã được kiểm tra	`"[email protected]"`
`is_disposable_email`	Liệu miền email có phải là dịch vụ email tạm thời/một lần sử dụng đã biết	`true`
`is_free_email`	Liệu miền email có phải là dịch vụ email miễn phí (ví dụ, gmail.com, yahoo.com)	`false`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`0`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Định dạng email không hợp lệ

Monitor API

API Monitor cho phép bạn theo dõi các bản cập nhật của các công ty. Mỗi bản cập nhật mới được biên dịch thành một nguồn cấp RSS duy nhất. Hệ thống theo dõi các blog công ty, hồ sơ X (Twitter) và những thay đổi trên trang web.

Các khái niệm cơ bản

Nguồn cấp: Vùng chứa cha. Một nguồn cấp có thể là công khai hoặc riêng tư. Các nguồn cấp riêng tư yêu cầu token của người mang được chuyển qua chuỗi truy vấn URL để đảm bảo khả năng tương thích với các trình đọc RSS tiêu chuẩn.
Mục tiêu: Một công ty/trang web cụ thể đang được theo dõi trong một nguồn cấp.
Cài đặt: Tùy chọn chi tiết trên mỗi mục tiêu quy định những gì cần theo dõi (Blog, X, Website) và tần suất.

Cách sử dụng

Giả sử bạn muốn theo dõi một nhóm trang web đối thủ cạnh tranh để tìm các bài đăng trên blog, hoạt động trên X và những thay đổi trên trang web, tất cả được gửi dưới dạng một nguồn cấp RSS duy nhất mà bạn có thể kết nối vào Feedly, Slack, Zapier hoặc bất kỳ trình đọc RSS nào.

1. Tạo một nguồn cấp với các mục tiêu — nhóm các công ty mà bạn muốn theo dõi vào một nguồn cấp. Mỗi công ty là mục tiêu được xác định bởi URL trang web của nó.

curl -X POST \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "SaaS Competitors", "targets": [ { "website_url": "https://stripe.com" }, { "website_url": "https://shopify.com" }, { "website_url": "https://vercel.com" } ] }' \ "https://nubela.co/api/v1/monitor/feeds"

Phản hồi bao gồm một rss_url — đây là URL mà bạn đăng ký.

{ "id": "feed_abc123", "rss_url": "https://nubela.co/.../rss.xml?token=sec_live_..." }

2. Đăng ký nguồn cấp RSS — sao chép rss_url và thêm nó vào bất kỳ trình đọc RSS nào (Feedly, Slack, Zapier, v.v.). Bài viết trên blog, bài viết X và thay đổi trang web từ tất cả các mục tiêu xuất hiện dưới dạng các mục trong một nguồn cấp duy nhất.

Stripe: Mở rộng Mạng Thanh toán của chúng tôi [blog] Vercel trên X: "Next.js 16 đã ra mắt" [x] Shopify: Trang Bảng giá [cập nhật trang web]

Mỗi mục bao gồm một danh mục (blog, x, website update, hoặc website new page). Xem Điểm cuối Tiêu thụ Nguồn cấp cho lược đồ RSS đầy đủ.

3. Thêm các mục tiêu mới — một đối thủ cạnh tranh mới vào thị trường? Thêm họ vào nguồn cấp.

curl -X POST \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "website_url": "https://linear.app" }' \ "https://nubela.co/api/v1/monitor/feeds/feed_abc123/targets"

4. Xóa các mục tiêu — một công ty không còn liên quan? Xóa nó khỏi nguồn cấp.

curl -X DELETE \ -H "Authorization: Bearer YOUR_API_KEY" \ "https://nubela.co/api/v1/monitor/feeds/feed_abc123/targets/target_xyz789"

5. Thay đổi cài đặt theo dõi — theo mặc định, mỗi mục tiêu theo dõi các bài viết blog, bài viết X và những thay đổi trang web trên chu kỳ 7 ngày. Sử dụng PATCH để chuyển đổi kênh hoặc thay đổi tần suất.

curl -X PATCH \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "settings": { "monitor_x": false, "frequency_days": 1 } }' \ "https://nubela.co/api/v1/monitor/feeds/feed_abc123/targets/target_xyz789"

Chỉ những trường bạn bao gồm bị thay đổi — các trường bị bỏ qua giữ giá trị hiện tại của chúng. Xem Đối tượng Cài đặt cho tất cả các tùy chọn có sẵn.

Bảng giá

Hành động	Chi phí
Tạo một nguồn cấp	3 tín dụng (một lần)
Kéo bài đăng blog (mỗi mục tiêu)	1 tín dụng/lần lấy
Kéo dữ liệu theo dõi website (mỗi đối tượng)	1 tín dụng/lần lấy
Kéo cập nhật bài đăng X (mỗi đối tượng)	2 tín dụng/lần lấy
Kéo cập nhật YouTube (trên mỗi mục tiêu)	1 tín dụng/lần lấy
Tất cả các điểm cuối khác (liệt kê, mô tả, xóa nguồn cấp; quản lý mục tiêu)	0 tín dụng

Mỗi lần kéo kiểm tra một mục tiêu cho một nguồn (blog, X, website hoặc YouTube). Với tất cả bốn nguồn được bật, một mục tiêu duy nhất chi phí 5 tín dụng cho mỗi lần lấy (1 blog + 2 X + 1 trang web + 1 YouTube).

Chi phí hàng tháng ví dụ

Kịch bản	Mục tiêu	Tần suất	Tín dụng/tháng
VC theo dõi 20 công ty danh mục	20	Hàng tuần	~433 tín dụng (3 một lần + 20 × 5 × 4,3 tuần)
Khởi động theo dõi 10 đối thủ cạnh tranh	10	Hàng ngày	~1,503 tín dụng (3 một lần + 10 × 5 × 30 ngày)
Nhóm bán hàng theo dõi 5 tài khoản khách hàng tiềm năng (chỉ blog + X, không có trang web)	5	Hàng ngày	~453 tín dụng (3 một lần + 5 × 3 × 30 ngày)

Chi phí tạo nguồn cấp một lần (3 tín dụng) chỉ được bao gồm trong tháng đầu tiên.

Điểm cuối Liệt kê Nguồn cấp

GET /api/v1/monitor/feeds

Chi phí: 0 tín dụng / yêu cầu.

Truy xuất danh sách tất cả các nguồn cấp sở hữu bởi người dùng được xác thực.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://nubela.co/api/v1/monitor/feeds"

Phản hồi ví dụ:

{
  "feeds": [
    {
      "id": "feed_abc123",
      "name": "SaaS Competitors",
      "is_public": false,
      "rss_url": "https://nubela.co/api/v1/monitor/feeds/feed_abc123/rss.xml?token=sec_live_987654321",
      "created_at": "2026-02-24T00:00:00Z",
      "target_count": 2
    }
  ]
}

Phản hồi

Khóa	Mô tả	Ví dụ
`feeds`	Danh sách các đối tượng nguồn cấp	Xem Feed Object

Feed Object

Khóa	Mô tả	Ví dụ
`id`	Mã định danh nguồn cấp duy nhất	`"feed_abc123"`
`name`	Tên nguồn cấp	`"SaaS Competitors"`
`is_public`	Liệu nguồn cấp có được truy cập công khai	`false`
`is_suspended`	Liệu nguồn cấp hiện tại có bị tạm ngừng	`false`
`suspension_reason`	Lý do tạm dừng, nếu bị tạm dừng	`null` hoặc `"insufficient_credits"`
`rss_url`	URL nguồn cấp RSS. Đối với các nguồn cấp riêng tư, bao gồm một tham số truy vấn token.	`"https://nubela.co/api/v1/monitor/feeds/feed_abc123/rss.xml?token=sec_live_987654321"`
`email_notifications`	Chế độ thông báo email	`"skip"` hoặc `"on_updates"`
`created_at`	Dấu thời gian tạo ISO 8601	`"2026-02-24T00:00:00Z"`
`target_count`	Số lượng mục tiêu trong nguồn cấp	`2`

Điểm cuối Nguồn cấp Mới

POST /api/v1/monitor/feeds

Chi phí: 3 tín dụng / yêu cầu (phí một lần).

Tạo một nguồn cấp mới và tùy chọn chấp nhận một mảng các mục tiêu ban đầu.

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "SaaS Competitors",
    "is_public": false,
    "targets": [
      {
        "website_url": "https://stripe.com",
        "settings": {
          "monitor_blog": true,
          "monitor_x": true,
          "monitor_website": true,
          "monitor_youtube": true,
          "frequency_days": 7
        }
      },
      {
        "website_url": "https://vercel.com"
      }
    ]
  }' \
  "https://nubela.co/api/v1/monitor/feeds"

Phản hồi ví dụ 201 Created:

{
  "id": "feed_abc123",
  "name": "SaaS Competitors",
  "is_public": false,
  "is_suspended": false,
  "suspension_reason": null,
  "rss_url": "https://nubela.co/api/v1/monitor/feeds/feed_abc123/rss.xml?token=sec_live_987654321",
  "created_at": "2026-02-24T09:55:00Z",
  "targets": [
    {
      "id": "target_xyz789",
      "website_url": "https://stripe.com",
      "settings": {
        "monitor_blog": true,
        "monitor_x": true,
        "monitor_website": true,
        "monitor_youtube": true,
        "frequency_days": 7
      },
      "last_polled_at": null,
      "is_baseline_complete": false,
      "created_at": "2026-02-24T09:55:00Z"
    },
    {
      "id": "target_xyz790",
      "website_url": "https://vercel.com",
      "settings": {
        "monitor_blog": true,
        "monitor_x": true,
        "monitor_website": true,
        "monitor_youtube": true,
        "frequency_days": 7
      },
      "last_polled_at": null,
      "is_baseline_complete": false,
      "created_at": "2026-02-24T09:55:00Z"
    }
  ]
}

Nội dung Yêu cầu

Tham số	Bắt buộc	Mô tả	Ví dụ
`name`	Không	Tên nguồn cấp. Nếu bỏ qua, một tên sẽ được tự động tạo.	`"SaaS Competitors"`
`is_public`	Không	Liệu nguồn cấp có được truy cập công khai (mặc định: `false`)	`false`
`email_notifications`	Không	Chế độ thông báo email. `"on_updates"` để nhận email khi phát hiện cập nhật mới, `"skip"` để vô hiệu hóa (mặc định: `"skip"`)	`"on_updates"`
`targets`	Có	Mảng các mục tiêu ban đầu được thêm vào nguồn cấp (ít nhất 1 bắt buộc)	Xem Đối tượng Đầu vào Mục tiêu

Đối tượng Đầu vào Mục tiêu

Tham số	Bắt buộc	Mô tả	Ví dụ
`website_url`	Có	URL trang web của công ty cần theo dõi	`"https://stripe.com"`
`settings`	Không	Tùy chọn theo dõi. Nếu bỏ qua, giá trị mặc định sẽ được áp dụng.	Xem Đối tượng Cài đặt

Đối tượng Cài đặt

Tham số	Bắt buộc	Mô tả	Ví dụ
`monitor_blog`	Không	Theo dõi blog của công ty để tìm các bài đăng mới (mặc định: `true`)	`true`
`monitor_x`	Không	Theo dõi tài khoản X (Twitter) của công ty (mặc định: `true`)	`true`
`monitor_website`	Không	Theo dõi trang web của công ty để tìm những thay đổi nội dung và các trang mới (mặc định: `true`)	`true`
`monitor_youtube`	Không	Theo dõi kênh YouTube chính thức của công ty để tìm các video mới (mặc định: `true`)	`true`
`frequency_days`	Không	Bao lâu kiểm tra cập nhật một lần, tính bằng ngày. Phải nằm trong khoảng 1 đến 30 (mặc định: `7`)	`7`

Quy tắc xác thực

Ít nhất một targets mục nhập là bắt buộc.
Mỗi mục tiêu phải có một website_url có thể truy cập được (phản hồi HTTP 2xx). URL không thể truy cập được trả lại 400.
Ít nhất một cài đặt theo dõi (monitor_blog, monitor_x, monitor_website, monitor_youtube) phải là true trên mỗi mục tiêu.

Phản hồi

Trả về 201 Created. Phản hồi bao gồm cái được tạo Feed Object với một bổ sung targets mảng chứa Đối tượng Mục tiêu mục nhập.

Đối tượng Mục tiêu

Khóa	Mô tả	Ví dụ
`id`	Mã định danh mục tiêu duy nhất	`"target_xyz789"`
`website_url`	URL trang web công ty được theo dõi	`"https://stripe.com"`
`settings`	Đối tượng tùy chọn theo dõi	Xem Đối tượng Cài đặt
`last_polled_at`	Dấu thời gian ISO 8601 của lần thăm dò gần nhất, hoặc `null` nếu không bao giờ được thăm dò	`null`
`is_baseline_complete`	Liệu ảnh chụp cơ bản ban đầu đã được ghi lại	`false`
`created_at`	Dấu thời gian tạo ISO 8601	`"2026-02-24T09:55:00Z"`

Tiêu đề Phản hồi

Khóa tiêu đề	Mô tả	Ví dụ
`X-NinjaPear-Credit-Cost`	Tổng chi phí tín dụng cho cuộc gọi API này	`3`

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Lỗi xác thực (mục tiêu bị thiếu, URL không thể truy cập, không có cờ giám sát nào được bật)

Điểm cuối Mô tả Nguồn cấp

GET /api/v1/monitor/feeds/{feed_id}

Chi phí: 0 tín dụng / yêu cầu.

Truy xuất các chi tiết đầy đủ của một nguồn cấp duy nhất, bao gồm tất cả các mục tiêu được đính kèm.

curl -G \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://nubela.co/api/v1/monitor/feeds/feed_abc123"

Phản hồi ví dụ:

{
  "id": "feed_abc123",
  "name": "SaaS Competitors",
  "is_public": false,
  "is_suspended": false,
  "suspension_reason": null,
  "rss_url": "https://nubela.co/api/v1/monitor/feeds/feed_abc123/rss.xml?token=sec_live_987654321",
  "created_at": "2026-02-24T09:55:00Z",
  "targets": [
    {
      "id": "target_xyz789",
      "website_url": "https://stripe.com",
      "settings": {
        "monitor_blog": true,
        "monitor_x": true,
        "monitor_website": true,
        "monitor_youtube": true,
        "frequency_days": 7
      },
      "last_polled_at": "2026-02-24T12:00:00Z",
      "is_baseline_complete": true,
      "created_at": "2026-02-24T09:55:00Z"
    },
    {
      "id": "target_xyz790",
      "website_url": "https://vercel.com",
      "settings": {
        "monitor_blog": true,
        "monitor_x": true,
        "monitor_website": true,
        "monitor_youtube": true,
        "frequency_days": 7
      },
      "last_polled_at": null,
      "is_baseline_complete": false,
      "created_at": "2026-02-24T09:55:00Z"
    }
  ]
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`feed_id`	Có	ID của nguồn cấp	`feed_abc123`

Phản hồi

Trả lại một Feed Object với một bổ sung targets mảng chứa Đối tượng Mục tiêu mục nhập.

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
404	Không	Không tìm thấy nguồn cấp

Điểm cuối Xóa Nguồn cấp

DELETE /api/v1/monitor/feeds/{feed_id}

Chi phí: 0 tín dụng / yêu cầu.

Xóa vĩnh viễn một nguồn cấp và tất cả các mục tiêu liên quan.

curl -X DELETE \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://nubela.co/api/v1/monitor/feeds/feed_abc123"

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`feed_id`	Có	ID của nguồn cấp để xóa	`feed_abc123`

Phản hồi

Trả về 200 OK với một thông báo xác nhận.

{
  "message": "Feed deleted."
}

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
404	Không	Không tìm thấy nguồn cấp

Thêm điểm cuối mục tiêu

POST /api/v1/monitor/feeds/{feed_id}/targets

Chi phí: 0 tín dụng / yêu cầu.

Thêm một công ty mới vào một nguồn cấp hiện có.

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "website_url": "https://shopify.com",
    "settings": {
      "monitor_blog": true,
      "monitor_x": true,
      "monitor_website": false,
      "frequency_days": 3
    }
  }' \
  "https://nubela.co/api/v1/monitor/feeds/feed_abc123/targets"

Phản hồi ví dụ 201 Created:

{
  "id": "target_xyz791",
  "website_url": "https://shopify.com",
  "settings": {
    "monitor_blog": true,
    "monitor_x": true,
    "monitor_website": false,
    "frequency_days": 3
  },
  "last_polled_at": null,
  "is_baseline_complete": false,
  "created_at": "2026-02-24T10:00:00Z"
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`feed_id`	Có	ID của nguồn cấp để thêm mục tiêu vào	`feed_abc123`

Nội dung Yêu cầu

Tham số	Bắt buộc	Mô tả	Ví dụ
`website_url`	Có	URL trang web của công ty cần theo dõi	`"https://shopify.com"`
`settings`	Không	Tùy chọn theo dõi. Nếu bỏ qua, giá trị mặc định sẽ được áp dụng.	Xem Đối tượng Cài đặt

Phản hồi

Trả lại một Đối tượng Mục tiêu.

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
404	Không	Không tìm thấy nguồn cấp

Cập nhật Điểm cuối Mục tiêu

PATCH /api/v1/monitor/feeds/{feed_id}/targets/{target_id}

Chi phí: 0 tín dụng / yêu cầu.

Sửa đổi các tùy chọn theo dõi cho một mục tiêu cụ thể.

curl -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "settings": {
      "frequency_days": 1,
      "monitor_website": true
    }
  }' \
  "https://nubela.co/api/v1/monitor/feeds/feed_abc123/targets/target_xyz789"

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`feed_id`	Có	ID của nguồn cấp	`feed_abc123`
`target_id`	Có	ID của mục tiêu để cập nhật	`target_xyz789`

Nội dung Yêu cầu

Tham số	Bắt buộc	Mô tả	Ví dụ
`settings`	Có	Cập nhật cài đặt một phần. Chỉ các trường được cung cấp mới được thay đổi.	Xem Đối tượng Cài đặt

Phản hồi

Trả lại cái đã cập nhật Đối tượng Mục tiêu.

Phản hồi ví dụ:

{
  "id": "target_xyz789",
  "website_url": "https://stripe.com",
  "settings": {
    "monitor_blog": true,
    "monitor_x": true,
    "monitor_website": true,
    "monitor_youtube": true,
    "frequency_days": 1
  },
  "last_polled_at": "2026-02-24T12:00:00Z",
  "is_baseline_complete": true,
  "created_at": "2026-02-24T09:55:00Z"
}

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Chưa cung cấp cài đặt hợp lệ nào
404	Không	Không tìm thấy nguồn cấp hoặc mục tiêu

Xóa Điểm Cuối Mục Tiêu

DELETE /api/v1/monitor/feeds/{feed_id}/targets/{target_id}

Chi phí: 0 tín dụng / yêu cầu.

Dừng theo dõi một trang web và xóa nó khỏi nguồn cấp.

curl -X DELETE \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://nubela.co/api/v1/monitor/feeds/feed_abc123/targets/target_xyz789"

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`feed_id`	Có	ID của nguồn cấp	`feed_abc123`
`target_id`	Có	ID của mục tiêu để xóa	`target_xyz789`

Phản hồi

Trả về 200 OK với một thông báo xác nhận.

{
  "message": "Target deleted."
}

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
404	Không	Không tìm thấy nguồn cấp hoặc mục tiêu

Điểm cuối Tiêu thụ Nguồn cấp

GET /api/v1/monitor/feeds/{feed_id}/rss.xml

Chi phí: 0 tín dụng / yêu cầu (chi phí theo dõi được tính cho từng lần kéo trên mỗi mục tiêu — xem Bảng giá).

Trả lại một nguồn cấp RSS 2.0 XML tiêu chuẩn được sử dụng bởi các trình đọc RSS (Feedly, Slack, tiện ích trình duyệt, v.v.).

Nếu của cái nguồn cấp is_public là false, một mã thông báo hợp lệ phải được truyền dưới dạng token tham số truy vấn.

curl "https://nubela.co/api/v1/monitor/feeds/feed_abc123/rss.xml?token=YOUR_RSS_TOKEN"

Phản hồi ví dụ:

<?xml version="1.0" encoding="UTF-8" ?>
<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
<channel>
  <title>SaaS Competitors</title>
  <link>https://nubela.co/api/v1/monitor/feeds/feed_abc123/rss.xml</link>
  <description>Automated updates for Stripe, Shopify, and Vercel.</description>
  <lastBuildDate>Tue, 24 Feb 2026 10:00:00 +0800</lastBuildDate>

  <item>
    <title>Stripe: Expanding our Global Payment Network</title>
    <link>https://stripe.com/blog/global-network-2026</link>
    <guid isPermaLink="true">https://stripe.com/blog/global-network-2026</guid>
    <pubDate>Mon, 23 Feb 2026 14:30:00 +0800</pubDate>
    <category>blog</category>
    <dc:creator>Stripe</dc:creator>
    <description>Stripe is expanding its payments infrastructure to 15 new countries, enabling merchants to accept local payment methods seamlessly.</description>
    <enclosure url="https://b.stripecdn.com/blog/og-global-network.jpg" length="150000" type="image/jpeg" />
  </item>

  <item>
    <title>Vercel on X: "Next.js 16 is here..."</title>
    <link>https://x.com/vercel/status/123456789</link>
    <guid isPermaLink="false">x_post_123456789</guid>
    <pubDate>Sun, 22 Feb 2026 10:15:00 +0800</pubDate>
    <category>x</category>
    <dc:creator>Vercel</dc:creator>
    <description>Next.js 16 is here, featuring completely redesigned server components and faster builds. Read the changelog.</description>
    <enclosure url="https://pbs.twimg.com/media/vercel-next16.jpg" length="85000" type="image/jpeg" />
  </item>

  <item>
    <title>Shopify: Pricing Page</title>
    <link>https://shopify.com/pricing</link>
    <guid isPermaLink="false">website_update_shopify_pricing_1708416000</guid>
    <pubDate>Fri, 20 Feb 2026 08:00:00 +0800</pubDate>
    <category>website update</category>
    <dc:creator>Shopify</dc:creator>
    <description>Compare Shopify's pricing plans to find the best fit for your business. Start your free trial today.</description>
    <enclosure url="https://cdn.shopify.com/assets/og-pricing.png" length="210000" type="image/png" />
  </item>

  <item>
    <title>Shopify: Enterprise Plus Solutions</title>
    <link>https://shopify.com/enterprise-plus</link>
    <guid isPermaLink="true">https://shopify.com/enterprise-plus</guid>
    <pubDate>Thu, 19 Feb 2026 11:20:00 +0800</pubDate>
    <category>website new page</category>
    <dc:creator>Shopify</dc:creator>
    <description>Unleash your brand's potential with Shopify Enterprise Plus. High-volume solutions for global commerce.</description>
    <enclosure url="https://cdn.shopify.com/assets/og-enterprise.jpg" length="320000" type="image/jpeg" />
  </item>

</channel>
</rss>

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`feed_id`	Có	ID của nguồn cấp	`feed_abc123`

Định dạng Phản hồi

Phản hồi là một tài liệu XML RSS 2.0 tiêu chuẩn. Cấu trúc như sau:

Các Phần tử Kênh

Phần tử	Mô tả	Ví dụ
`<title>`	Tên của nguồn cấp	`SaaS Competitors`
`<link>`	URL của nguồn cấp RSS	`https://nubela.co/api/v1/monitor/feeds/feed_abc123/rss.xml`
`<description>`	Tóm tắt được tạo tự động của các công ty được theo dõi	`Automated updates for Stripe, Shopify, and Vercel.`
`<lastBuildDate>`	Dấu thời gian RFC 2822 của lần xây dựng nguồn cấp cuối cùng	`Tue, 24 Feb 2026 10:00:00 +0800`

Item Elements

Mỗi <item> đại diện cho một bản cập nhật từ một công ty được theo dõi.

Phần tử	Mô tả	Ví dụ
`<title>`	Cập nhật tiêu đề, được bắt đầu bằng tên công ty	`Stripe: Expanding our Global Payment Network`
`<link>`	URL của nội dung gốc	`https://stripe.com/blog/global-network-2026`
`<guid>`	Mã định danh duy nhất cho mục. `isPermaLink` là `true` khi GUID là URL.	`https://stripe.com/blog/global-network-2026`
`<pubDate>`	Dấu thời gian xuất bản RFC 2822	`Mon, 23 Feb 2026 14:30:00 +0800`
`<category>`	Loại cập nhật (xem danh mục dưới đây)	`blog`
`<dc:creator>`	Tên công ty (sử dụng không gian tên Dublin Core)	`Stripe`
`<description>`	Tóm tắt hoặc trích đoạn của bản cập nhật	Nội dung văn bản
`<enclosure>`	Tệp đính kèm hình ảnh tùy chọn có `url`, `length` (bytes), và `type` (MIME type) thuộc tính	`<enclosure url="..." length="150000" type="image/jpeg" />`

Danh mục Mục RSS

Mỗi <item> bao gồm một <category> phần tử chỉ ra loại cập nhật:

Danh mục	Mô tả
`blog`	Một bài đăng blog mới từ công ty
`x`	Một bài đăng từ tài khoản X (Twitter) của công ty
`website update`	Phát hiện một thay đổi trên trang hiện có
`website new page`	Phát hiện một trang mới trên trang web của công ty
`website unreachable`	Trang web của công ty không thể truy cập được (được kích hoạt một lần)

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
403	Không	Thiếu hoặc không hợp lệ token cho một nguồn cấp riêng tư
404	Không	Không tìm thấy nguồn cấp

Cập nhật Điểm cuối Nguồn cấp

PATCH /api/v1/monitor/feeds/{feed_id}

Chi phí: 0 tín dụng / yêu cầu.

Cập nhật cài đặt nguồn cấp như tên, khả năng hiển thị hoặc trạng thái tạm dừng. Nguồn cấp tạm dừng trong insufficient_credits được tiếp tục tự động khi thêm tín dụng.

# Suspend a feed
curl -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "is_suspended": true, "suspension_reason": "manual" }' \
  "https://nubela.co/api/v1/monitor/feeds/feed_abc123"

import requests

response = requests.patch(
    "https://nubela.co/api/v1/monitor/feeds/feed_abc123",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"is_suspended": True, "suspension_reason": "manual"},
)

const response = await fetch(
  "https://nubela.co/api/v1/monitor/feeds/feed_abc123",
  {
    method: "PATCH",
    headers: {
      Authorization: "Bearer YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ is_suspended: true, suspension_reason: "manual" }),
  },
);

Phản hồi ví dụ (giống như Describe Feed):

{
  "id": "feed_abc123",
  "name": "My Feed",
  "is_public": false,
  "is_suspended": true,
  "suspension_reason": "manual",
  "rss_url": "https://nubela.co/api/v1/monitor/feeds/feed_abc123/rss.xml?token=...",
  "created_at": "2025-01-15T10:30:00Z",
  "targets": [...]
}

Tham số URL

Tham số	Bắt buộc	Mô tả	Ví dụ
`feed_id`	Có	ID của nguồn cấp	`feed_abc123`

Nội dung Yêu cầu

Tham số	Bắt buộc	Mô tả	Ví dụ
`name`	Không	Tên nguồn cấp mới	`"My Feed"`
`is_public`	Không	Liệu nguồn cấp RSS có được truy cập công khai	`true`
`is_suspended`	Không	Đặt `true` để tạm dừng, `false` để tiếp tục	`true`
`suspension_reason`	Không	Lý do tạm dừng (chỉ khi `is_suspended` là `true`, mặc định `"manual"`)	`"manual"`
`email_notifications`	Không	Chế độ thông báo email. `"on_updates"` để nhận email khi phát hiện cập nhật mới, `"skip"` để vô hiệu hóa	`"on_updates"`

Ít nhất một trường phải được cung cấp.

Phản hồi

Trả lại cái đã cập nhật Feed Object với một bổ sung targets mảng chứa Đối tượng Mục tiêu mục nhập.

Mã lỗi

Mã Trạng Thái	Được tính phí?	Mô tả
400	Không	Chưa cung cấp trường nào hợp lệ
404	Không	Không tìm thấy nguồn cấp

Claude AI

NinjaPear cung cấp một máy chủ MCP (Model Context Protocol) để tích hợp trực tiếp với Claude. Điều này cho phép bạn truy vấn dữ liệu công ty B2B một cách hội thoại — hãy hỏi Claude về khách hàng, nhà đầu tư, số nhân viên của bất kỳ công ty nào, và nhiều hơn nữa.

Bắt đầu nhanh

Lấy chuỗi kết nối của bạn từ Bảng điều khiển
Thêm NinjaPear làm trình kết nối trong Claude (xem hướng dẫn thiết lập bên dưới)
Bắt đầu một cuộc trò chuyện mới và truy vấn dữ liệu công ty B2B theo cách hội thoại

Thiết lập

Chuỗi kết nối của bạn có sẵn trên Bảng điều khiển. Nó trông như thế này: https://nubela.co/mcp/sse?api_key=YOUR_API_KEY

Claude Platform (Được khuyến nghị)

Lấy chuỗi kết nối của bạn từ Bảng điều khiển
Hãy chắc chắn rằng bạn đã đăng nhập vào Claude, sau đó truy cập: Thêm trình kết nối tùy chỉnh
Nhập những điều sau:
- Tên: NinjaPear
- URL Máy chủ MCP từ xa: Dán chuỗi kết nối của bạn từ bước 1
Nhấp Thêm trình kết nối
Bắt đầu một cuộc trò chuyện mới và yêu cầu Claude sử dụng NinjaPear

Claude Code CLI

Lấy chuỗi kết nối của bạn từ Bảng điều khiển, sau đó chạy:

claude mcp add ninjapear --transport sse "YOUR_CONNECTOR_STRING"

Công cụ có sẵn

Công cụ	Mô tả	Chi phí
`get_customer_listing`	Lấy khách hàng, nhà đầu tư và đối tác của công ty	1 + 2/công ty
`get_company_details`	Lấy thông tin công ty, giám đốc điều hành, tài chính	2-4 tín dụng
`get_employee_count`	Lấy số lượng nhân viên cho công ty	2 tín dụng
`check_disposable_email`	Kiểm tra xem email có phải là dùng một lần/miễn phí	MIỄN PHÍ
`get_credit_balance`	Kiểm tra số dư tín dụng của bạn	MIỄN PHÍ
`get_company_logo_url`	Lấy URL logo công ty	MIỄN PHÍ
`list_feeds`	Liệt kê tất cả các nguồn cấp theo dõi của bạn	0 tín dụng
`create_feed`	Tạo một nguồn cấp theo dõi mới với các mục tiêu	3 tín dụng
`describe_feed`	Lấy chi tiết nguồn cấp với tất cả các mục tiêu	0 tín dụng
`update_feed`	Cập nhật tên nguồn cấp, khả năng hiển thị hoặc tạm dừng	0 tín dụng
`delete_feed`	Xóa một nguồn cấp và tất cả các mục tiêu của nó	0 tín dụng
`add_target`	Thêm một công ty để theo dõi trong một nguồn cấp	0 tín dụng
`update_target`	Cập nhật cài đặt theo dõi cho một mục tiêu	0 tín dụng
`remove_target`	Xóa một công ty khỏi một nguồn cấp	0 tín dụng
`consume_feed`	Đọc các bản cập nhật mới nhất từ một nguồn cấp	MIỄN PHÍ

Ví dụ Prompts

Sau khi kết nối, bạn có thể hỏi Claude những câu hỏi như:

Thông tin cạnh tranh

Bạn là người quản lý sản phẩm theo dõi những gì đối thủ cạnh tranh của bạn đang làm.

"Monitor stripe.com, brex.com, và ramp.com for blog posts and website changes. Check daily."
"What are the latest updates from my competitor feed?"
"Get company details for each of my competitors — I want to know their employee counts and executives"
"Who are Stripe's customers? Cross-reference them with Brex's customers to find overlap"

VC Portfolio Monitoring

Bạn là nhà đầu tư mạo hiểm muốn theo dõi hoạt động của các công ty danh mục. Tải lên một tệp CSV hoặc ảnh chụp màn hình các công ty danh mục của bạn lên Claude, sau đó hỏi:

"Create a monitoring feed for all these companies — track their blogs and website changes weekly"
"Show me the latest updates across my portfolio feed"
"Get employee counts for each of my portfolio companies — I want to see who's growing fastest"
"Which of my portfolio companies have the most customers?"

Tìm kiếm khách hàng tiềm năng

Bạn làm việc trong bộ phận bán hàng và muốn nghiên cứu các tài khoản trước khi liên hệ.

"Get company details for acme.com — who are their executives, and what industry are they in?"
"How many employees does acme.com have?"
"Who are Salesforce's customers? Get company details for the top 5 by employee count"
"Is [email protected] a real business email or a disposable address?"
"Check if these emails are disposable: [email protected], [email protected]"

Nghiên Cứu Thị Trường

Bạn là một nhà phân tích lập bản đồ bối cảnh ngành.

"Find the investors behind Figma, Canva, and Miro. Who are the common VCs?"
"Get company details for anthropic.com, openai.com, và cohere.com — compare their founding year, employee count, and specialties"
"Who are the partners of Shopify? Get employee counts for each partner"
"Get logos for stripe.com, square.com, và adyen.com — I'm building a market map"

Theo dõi và Cảnh báo

Bạn muốn thiết lập theo dõi liên tục và quay lại để kiểm tra các bản cập nhật.

"Create a feed called 'AI Companies' to track openai.com, anthropic.com, and deepmind.google — monitor blogs and X posts"
"Add mistral.ai to my AI Companies feed"
"Change the monitoring frequency for Anthropic to daily — they ship fast"
"Pause my AI Companies feed for now, I'll resume it next quarter"
"What's my current credit balance? How long will my monitoring last at this rate?"

Quản lý tài khoản

Kiểm tra nhanh cách sử dụng NinjaPear của bạn.

"What's my credit balance?"
"How many credits do I have left?"

Xử lý lỗi

Các lỗi được trả về dưới dạng các thông báo mô tả mà Claude sẽ giải thích cho bạn:

Lỗi	Tin nhắn
API key không hợp lệ	"Error: 401 Unauthorized"
Tín dụng không đủ	"Error: 402 Payment Required"
Đã đạt giới hạn tỷ lệ	"Error: 429 Too Many Requests"
Lỗi máy chủ	"Error: 500 Internal Server Error"

Chi tiết Kỹ thuật

MCP Protocol

Máy chủ NinjaPear MCP triển khai Model Context Protocol specification, là tiêu chuẩn mở của Anthropic để kết nối các trợ lý AI với các nguồn dữ liệu bên ngoài và công cụ.

Vận chuyển

Chúng tôi sử dụng vận chuyển Server-Sent Events (SSE) để liên lạc trong thời gian thực:

SSE điểm cuối: GET /mcp/sse?api_key=YOUR_API_KEY
Điểm cuối Tin nhắn: POST /mcp/messages/
Kiểm tra sức khỏe: GET /mcp/health

Xác thực

Truyền khóa API của bạn thông qua api_key tham số truy vấn hoặc X-API-Key tiêu đề