API Hop

문서

API Hop 문서

SimilarwebAPI

인증된 REST 엔드포인트로 웹사이트 트래픽, 검색 키워드, 백링크, 유입, 경쟁 사이트 및 참여도를 조회합니다.

SimilarwebAPI는 /v1/similarweb 아래에 27개의 읽기 전용 데이터 엔드포인트를 제공합니다. 다른 RequestBeam API와 동일한 계정, API 키, 잔액 및 사용 기록을 사용합니다. 가용성은 게이트웨이 활성화 및 API 키 권한에 따라 달라지며, 문서는 프로덕션 가용성을 확인하지 않습니다.

인증

타사 자격 증명이 아닌 RequestBeam API 키를 전송하세요:

http
Authorization: Bearer YOUR_API_KEY

요청 예제

모든 공개 작업은 요청 본문 없이 쿼리 매개변수와 GET을 사용합니다. 경로와 매개변수의 대소문자를 문서와 정확히 일치시키세요.

전 세계 데이터(country=999)만 지원합니다. 그 밖의 유효한 국가 값은 업스트림 요청 전에 999로 변경되며, 지정한 국가가 아닌 전 세계 데이터가 반환됩니다.

날짜를 허용하는 엔드포인트에서는 유효하고 완전한 명시적 from/to 범위가 우선합니다. latest를 허용하는 엔드포인트에서는 입력값에 기존 형식 및 엔드포인트별 검증을 적용하지만, 범위 선택에는 사용하지 않고 Similarweb에도 보내지 않으며 기본 latest도 추가하지 않습니다. 명시적 범위가 없으면 기존 latest, 기본값 및 기간 동작은 그대로 유지됩니다. History 제한은 계속 적용되며 latest를 허용하지 않는 엔드포인트는 여전히 해당 필드를 거부합니다.

bash
curl --get "https://api.apihop.ai/v1/similarweb/websites/incoming-referrals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "key=example.com" \
  --data-urlencode "country=999" \
  --data-urlencode "page=1"

유입 참조는 keys가 아닌 소문자 key에 단일 호스트 이름을 사용합니다. 이 key는 대상 웹사이트를 지정하는 업무 쿼리 매개변수이며 API 자격 증명이 아닙니다. 명시적으로 허용된 Similarweb GET 경로에서만 사용할 수 있습니다. API 인증은 계속 Authorization을 사용하며 다른 자격 증명 쿼리 필드는 금지됩니다. 행은 Data가 아닌 Records에 반환됩니다. 작업별 정확한 필드는 전체 엔드포인트 참조를 확인하세요.

조회 범위

  • 검색: 키워드 제안, 순위 페이지, 웹사이트 키워드, 자연 및 유료 검색, 브랜드 키워드.
  • 웹사이트 트래픽: 참여도, 방문 수, 지역, 기기 구성, 채널 및 소셜 트래픽.
  • 관계: 백링크, 유입 참조, 유출 트래픽 및 유사 웹사이트.
  • 기록: 월별 방문 수, 이탈률, 방문 시간 및 방문당 페이지 수의 개별 시계열.

응답 형식

성공 응답은 새로운 success/data 봉투 없이 원래 JSON 본문을 유지합니다. 필드 이름, 알 수 없는 필드, 빈 배열 및 숫자 정밀도는 바뀌지 않습니다. 엔드포인트마다 Data, Records 또는 다른 원래 구조를 반환할 수 있으므로 공통 행 필드가 있다고 가정하지 마세요.

성공한 빈 결과가 도메인에 트래픽이 없다는 뜻은 아닙니다. 실패한 요청을 빈 데이터로 처리해서는 안 됩니다. 문제 해결을 위해 X-Request-Id와 요청 시각을 보관하세요.

청구 및 페이지 매김

27개 엔드포인트 모두 표준 요금은 성공 요청당 $0.0005, 즉 1,000회 요청당 $0.50입니다. 행이 아닌 요청별로 청구하며, 성공한 빈 결과도 요청 1회로 계산합니다. 이후 각 페이지는 별도 요청입니다. 계정별 요금이 설정되면 우선 적용합니다. 잘못된 매개변수, 누락된 인증 또는 잔액 부족 요청은 성공한 청구 대상 호출로 진행되지 않습니다. 상위 공급자에서 실패한 요청에는 요금을 청구하지 않습니다.

플랫폼의 최소 잔액 정책에 따라 호출 전에 계정에 최소 $0.10의 사용 가능한 잔액이 있어야 합니다. 표준 요금은 여전히 성공 요청당 $0.0005입니다.

선택한 엔드포인트 문서에 명시된 페이지 매김 필드만 사용하세요. 페이지 번호는 일반적으로 1부터 시작합니다. 백링크는 Page와 PageSize를 사용하고 다른 표는 page, pageSize 또는 rowsPerPage를 사용할 수 있습니다. 지원하지 않는 페이지 크기 필드는 전송하지 마세요.

오류

플랫폼 오류는 다음 구조를 사용합니다. code는 HTTP 상태가 아닌 플랫폼 업무 코드입니다:

json
{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}

일반적인 HTTP 상태는 잘못된 쿼리 400, 잘못된 API 키 401, 잔액 부족 402, 게이트웨이 접근 거부 403, 속도 제한 429, 일시적인 공급자 또는 서비스 실패 5xx입니다. 형식이 잘못된 요청을 수정 없이 재시도하지 마세요.