Skip to content

Commit acde128

Browse files
nexscopenexscope
committed
Use GithubAMapi attribution across repository
1 parent 64b1769 commit acde128

4 files changed

Lines changed: 65 additions & 44 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
**Product, keyword, traffic, review, sales, pricing, market, and competitor intelligence through one API key.**
66

77
[![Validate examples](https://github.com/nexscope-ai/amazon-data-api/actions/workflows/validate.yml/badge.svg)](https://github.com/nexscope-ai/amazon-data-api/actions/workflows/validate.yml)
8-
[![API docs](https://img.shields.io/badge/API-docs-7c3aed)](https://www.nexscope.ai/api-docs?co-from=github)
8+
[![API docs](https://img.shields.io/badge/API-docs-7c3aed)](https://www.nexscope.ai/api-docs?co-from=GithubAMapi)
99
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
1010

11-
[Get an API key](https://www.nexscope.ai/seller/api-access?co-from=github) · [Browse every API](./api-catalog/README.md) · [Read the full documentation](https://www.nexscope.ai/api-docs?co-from=github)
11+
[Get an API key](https://www.nexscope.ai/seller/api-access?co-from=GithubAMapi) · [Browse every API](./api-catalog/README.md) · [Read the full documentation](https://www.nexscope.ai/api-docs?co-from=GithubAMapi)
1212

1313
</div>
1414

@@ -20,7 +20,7 @@ Nexscope provides developer access to Amazon marketplace data for product discov
2020

2121
### 1. Create an API key
2222

23-
Sign in to [Nexscope API Access](https://www.nexscope.ai/seller/api-access?co-from=github), create a key, and keep it private.
23+
Sign in to [Nexscope API Access](https://www.nexscope.ai/seller/api-access?co-from=GithubAMapi), create a key, and keep it private.
2424

2525
```bash
2626
export NEXSCOPE_API_KEY="YOUR_API_KEY"
@@ -36,7 +36,7 @@ curl -X POST \
3636
-d '{"keyword":"phone case","page":1}'
3737
```
3838

39-
The response schema, supported marketplaces, request fields, and known limitations are documented on the [Amazon Search API page](https://www.nexscope.ai/api-docs/amazon-search?co-from=github).
39+
The response schema, supported marketplaces, request fields, and known limitations are documented on the [Amazon Search API page](https://www.nexscope.ai/api-docs/amazon-search?co-from=GithubAMapi).
4040

4141
### 3. Try another language
4242

@@ -115,7 +115,7 @@ Do not log API keys, paste them into issues, commit them to a repository, or exp
115115

116116
## AI agent skills
117117

118-
Building an agent rather than a REST integration? The companion [`nexscope-ecommerce-skills`](https://github.com/nexscope-ai/nexscope-ecommerce-skills) repository packages these capabilities for compatible AI agents.
118+
Building an agent rather than a REST integration? The companion [`nexscope-ecommerce-skills`](https://github.com/nexscope-ai/nexscope-ecommerce-skills?co-from=GithubAMapi) repository packages these capabilities for compatible AI agents.
119119

120120
## Contributing
121121

@@ -131,4 +131,4 @@ The example code in this repository is available under the [MIT License](./LICEN
131131

132132
---
133133

134-
Built by **[Nexscope](https://www.nexscope.ai/?co-from=github)** — an AI agent for ecommerce automation that connects marketplace data with product research, keyword analysis, pricing, reviews, and growth workflows.
134+
Built by **[Nexscope](https://www.nexscope.ai/?co-from=GithubAMapi)** — an AI agent for ecommerce automation that connects marketplace data with product research, keyword analysis, pricing, reviews, and growth workflows.

‎api-catalog/README.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,61 +14,61 @@ Authenticate with `Authorization: Bearer YOUR_API_KEY` and `Content-Type: applic
1414

1515
| API | What it does |
1616
|---|---|
17-
| [Amazon Alexa Search](https://www.nexscope.ai/api-docs/amazon-alexa-search?co-from=github) | Search Amazon Alexa shopping results. |
18-
| [Amazon Broad Product Search](https://www.nexscope.ai/api-docs/amazon-broad-product-search?co-from=github) | Search and filter products using broad research criteria. |
19-
| [Amazon Market Product Search](https://www.nexscope.ai/api-docs/amazon-market-product-search?co-from=github) | Search products in an Amazon marketplace. |
20-
| [Amazon Product Database Search](https://www.nexscope.ai/api-docs/amazon-product-database-search?co-from=github) | Search the Amazon product database with product metrics. |
21-
| [Amazon Product Discovery](https://www.nexscope.ai/api-docs/amazon-product-discovery?co-from=github) | Discover products using marketplace and performance filters. |
22-
| [Amazon Related ASINs](https://www.nexscope.ai/api-docs/amazon-related-asins?co-from=github) | Retrieve ASINs related to a target ASIN. |
23-
| [Amazon Search](https://www.nexscope.ai/api-docs/amazon-search?co-from=github) | Retrieve storefront search results and ranking data. |
24-
| [Amazon Search by Image](https://www.nexscope.ai/api-docs/amazon-search-by-image?co-from=github) | Find visually similar Amazon products from an image URL. |
17+
| [Amazon Alexa Search](https://www.nexscope.ai/api-docs/amazon-alexa-search?co-from=GithubAMapi) | Search Amazon Alexa shopping results. |
18+
| [Amazon Broad Product Search](https://www.nexscope.ai/api-docs/amazon-broad-product-search?co-from=GithubAMapi) | Search and filter products using broad research criteria. |
19+
| [Amazon Market Product Search](https://www.nexscope.ai/api-docs/amazon-market-product-search?co-from=GithubAMapi) | Search products in an Amazon marketplace. |
20+
| [Amazon Product Database Search](https://www.nexscope.ai/api-docs/amazon-product-database-search?co-from=GithubAMapi) | Search the Amazon product database with product metrics. |
21+
| [Amazon Product Discovery](https://www.nexscope.ai/api-docs/amazon-product-discovery?co-from=GithubAMapi) | Discover products using marketplace and performance filters. |
22+
| [Amazon Related ASINs](https://www.nexscope.ai/api-docs/amazon-related-asins?co-from=GithubAMapi) | Retrieve ASINs related to a target ASIN. |
23+
| [Amazon Search](https://www.nexscope.ai/api-docs/amazon-search?co-from=GithubAMapi) | Retrieve storefront search results and ranking data. |
24+
| [Amazon Search by Image](https://www.nexscope.ai/api-docs/amazon-search-by-image?co-from=GithubAMapi) | Find visually similar Amazon products from an image URL. |
2525

2626
## Product, sales, and price data
2727

2828
| API | What it does |
2929
|---|---|
30-
| [Amazon Market Product Detail](https://www.nexscope.ai/api-docs/amazon-market-product-detail?co-from=github) | Retrieve marketplace product details. |
31-
| [Amazon Product Database](https://www.nexscope.ai/api-docs/amazon-product-database?co-from=github) | Query a product database using research filters. |
32-
| [Amazon Product Detail](https://www.nexscope.ai/api-docs/amazon-product-detail?co-from=github) | Retrieve details for one or more ASINs. |
33-
| [Amazon Product History](https://www.nexscope.ai/api-docs/amazon-product-history?co-from=github) | Retrieve historical product data and current details. |
34-
| [Amazon Product Price Series](https://www.nexscope.ai/api-docs/amazon-product-price-series?co-from=github) | Retrieve price, BSR, and other product metric series. |
35-
| [Amazon Sales Estimates](https://www.nexscope.ai/api-docs/amazon-sales-estimates?co-from=github) | Estimate historical daily sales for a product. |
30+
| [Amazon Market Product Detail](https://www.nexscope.ai/api-docs/amazon-market-product-detail?co-from=GithubAMapi) | Retrieve marketplace product details. |
31+
| [Amazon Product Database](https://www.nexscope.ai/api-docs/amazon-product-database?co-from=GithubAMapi) | Query a product database using research filters. |
32+
| [Amazon Product Detail](https://www.nexscope.ai/api-docs/amazon-product-detail?co-from=GithubAMapi) | Retrieve details for one or more ASINs. |
33+
| [Amazon Product History](https://www.nexscope.ai/api-docs/amazon-product-history?co-from=GithubAMapi) | Retrieve historical product data and current details. |
34+
| [Amazon Product Price Series](https://www.nexscope.ai/api-docs/amazon-product-price-series?co-from=GithubAMapi) | Retrieve price, BSR, and other product metric series. |
35+
| [Amazon Sales Estimates](https://www.nexscope.ai/api-docs/amazon-sales-estimates?co-from=GithubAMapi) | Estimate historical daily sales for a product. |
3636

3737
## Keyword and traffic intelligence
3838

3939
| API | What it does |
4040
|---|---|
41-
| [Amazon ASIN Keywords](https://www.nexscope.ai/api-docs/amazon-asin-keywords?co-from=github) | Retrieve keywords associated with an ASIN. |
42-
| [Amazon ASIN Traffic Summary](https://www.nexscope.ai/api-docs/amazon-asin-traffic-summary?co-from=github) | Analyze ASIN traffic-source composition. |
43-
| [Amazon Keyword Expansion](https://www.nexscope.ai/api-docs/amazon-keyword-expansion?co-from=github) | Expand a seed keyword into related terms. |
44-
| [Amazon Keyword Intelligence](https://www.nexscope.ai/api-docs/amazon-keyword-intelligence?co-from=github) | Query Amazon search-term intelligence data. |
45-
| [Amazon Keyword Overview](https://www.nexscope.ai/api-docs/amazon-keyword-overview?co-from=github) | Retrieve an overview for an Amazon keyword. |
46-
| [Amazon Keyword Search History](https://www.nexscope.ai/api-docs/amazon-keyword-search-history?co-from=github) | Retrieve historical keyword search-volume data. |
47-
| [Amazon Keyword Share of Voice](https://www.nexscope.ai/api-docs/amazon-keyword-share-of-voice?co-from=github) | Analyze keyword share of voice. |
48-
| [Amazon Keyword Summary](https://www.nexscope.ai/api-docs/amazon-keyword-summary?co-from=github) | Retrieve summary metrics for a keyword. |
49-
| [Amazon Traffic Keywords](https://www.nexscope.ai/api-docs/amazon-traffic-keywords?co-from=github) | Research traffic-driving keywords for an ASIN. |
41+
| [Amazon ASIN Keywords](https://www.nexscope.ai/api-docs/amazon-asin-keywords?co-from=GithubAMapi) | Retrieve keywords associated with an ASIN. |
42+
| [Amazon ASIN Traffic Summary](https://www.nexscope.ai/api-docs/amazon-asin-traffic-summary?co-from=GithubAMapi) | Analyze ASIN traffic-source composition. |
43+
| [Amazon Keyword Expansion](https://www.nexscope.ai/api-docs/amazon-keyword-expansion?co-from=GithubAMapi) | Expand a seed keyword into related terms. |
44+
| [Amazon Keyword Intelligence](https://www.nexscope.ai/api-docs/amazon-keyword-intelligence?co-from=GithubAMapi) | Query Amazon search-term intelligence data. |
45+
| [Amazon Keyword Overview](https://www.nexscope.ai/api-docs/amazon-keyword-overview?co-from=GithubAMapi) | Retrieve an overview for an Amazon keyword. |
46+
| [Amazon Keyword Search History](https://www.nexscope.ai/api-docs/amazon-keyword-search-history?co-from=GithubAMapi) | Retrieve historical keyword search-volume data. |
47+
| [Amazon Keyword Share of Voice](https://www.nexscope.ai/api-docs/amazon-keyword-share-of-voice?co-from=GithubAMapi) | Analyze keyword share of voice. |
48+
| [Amazon Keyword Summary](https://www.nexscope.ai/api-docs/amazon-keyword-summary?co-from=GithubAMapi) | Retrieve summary metrics for a keyword. |
49+
| [Amazon Traffic Keywords](https://www.nexscope.ai/api-docs/amazon-traffic-keywords?co-from=GithubAMapi) | Research traffic-driving keywords for an ASIN. |
5050

5151
## Market, niche, and opportunity research
5252

5353
| API | What it does |
5454
|---|---|
55-
| [Amazon Market Research](https://www.nexscope.ai/api-docs/amazon-market-research?co-from=github) | Search markets using demand and competition filters. |
56-
| [Amazon Market Statistics](https://www.nexscope.ai/api-docs/amazon-market-statistics?co-from=github) | Analyze statistics for an Amazon market or category. |
57-
| [Amazon Niche Info](https://www.nexscope.ai/api-docs/amazon-niche-info?co-from=github) | Retrieve details for a niche identifier. |
58-
| [Amazon Niche Info by ASIN](https://www.nexscope.ai/api-docs/amazon-niche-info-by-asin?co-from=github) | Find niche information from an ASIN. |
59-
| [Amazon Niche Info by Keyword](https://www.nexscope.ai/api-docs/amazon-niche-info-by-keyword?co-from=github) | Find niches associated with a keyword. |
60-
| [Amazon Niche Reviews by Keyword](https://www.nexscope.ai/api-docs/amazon-niche-reviews-by-keyword?co-from=github) | Retrieve niche review data from a keyword. |
61-
| [Amazon Opportunity Report by Keyword](https://www.nexscope.ai/api-docs/amazon-opportunity-report-by-keyword?co-from=github) | Generate an opportunity report for a keyword. |
62-
| [Amazon Opportunity Search by Metrics](https://www.nexscope.ai/api-docs/amazon-opportunity-search-by-metrics?co-from=github) | Search opportunities using numeric filters. |
55+
| [Amazon Market Research](https://www.nexscope.ai/api-docs/amazon-market-research?co-from=GithubAMapi) | Search markets using demand and competition filters. |
56+
| [Amazon Market Statistics](https://www.nexscope.ai/api-docs/amazon-market-statistics?co-from=GithubAMapi) | Analyze statistics for an Amazon market or category. |
57+
| [Amazon Niche Info](https://www.nexscope.ai/api-docs/amazon-niche-info?co-from=GithubAMapi) | Retrieve details for a niche identifier. |
58+
| [Amazon Niche Info by ASIN](https://www.nexscope.ai/api-docs/amazon-niche-info-by-asin?co-from=GithubAMapi) | Find niche information from an ASIN. |
59+
| [Amazon Niche Info by Keyword](https://www.nexscope.ai/api-docs/amazon-niche-info-by-keyword?co-from=GithubAMapi) | Find niches associated with a keyword. |
60+
| [Amazon Niche Reviews by Keyword](https://www.nexscope.ai/api-docs/amazon-niche-reviews-by-keyword?co-from=GithubAMapi) | Retrieve niche review data from a keyword. |
61+
| [Amazon Opportunity Report by Keyword](https://www.nexscope.ai/api-docs/amazon-opportunity-report-by-keyword?co-from=GithubAMapi) | Generate an opportunity report for a keyword. |
62+
| [Amazon Opportunity Search by Metrics](https://www.nexscope.ai/api-docs/amazon-opportunity-search-by-metrics?co-from=GithubAMapi) | Search opportunities using numeric filters. |
6363

6464
## Competitors, reviews, and policy
6565

6666
| API | What it does |
6767
|---|---|
68-
| [Amazon Competitor Lookup](https://www.nexscope.ai/api-docs/amazon-competitor-lookup?co-from=github) | Find and analyze competing Amazon products. |
69-
| [Amazon Policy Feed](https://www.nexscope.ai/api-docs/amazon-policy-feed?co-from=github) | Retrieve marketplace policy updates and article details. |
70-
| [Amazon Reviews List](https://www.nexscope.ai/api-docs/amazon-reviews-list?co-from=github) | Retrieve product reviews with rating and sorting controls. |
68+
| [Amazon Competitor Lookup](https://www.nexscope.ai/api-docs/amazon-competitor-lookup?co-from=GithubAMapi) | Find and analyze competing Amazon products. |
69+
| [Amazon Policy Feed](https://www.nexscope.ai/api-docs/amazon-policy-feed?co-from=GithubAMapi) | Retrieve marketplace policy updates and article details. |
70+
| [Amazon Reviews List](https://www.nexscope.ai/api-docs/amazon-reviews-list?co-from=GithubAMapi) | Retrieve product reviews with rating and sorting controls. |
7171

7272
## Next step
7373

74-
Create or manage a key in [Nexscope API Access](https://www.nexscope.ai/seller/api-access?co-from=github), then use the payload library in [`examples/payloads`](../examples/payloads/) or the machine-readable [`examples/requests.json`](../examples/requests.json).
74+
Create or manage a key in [Nexscope API Access](https://www.nexscope.ai/seller/api-access?co-from=GithubAMapi), then use the payload library in [`examples/payloads`](../examples/payloads/) or the machine-readable [`examples/requests.json`](../examples/requests.json).

‎recipes/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ API calls may consume credits. Before scheduling a batch or recurring job:
5050
- never retry authentication, permission, or insufficient-credit errors automatically;
5151
- cache stable results when permitted by your use case and account rules.
5252

53-
Create or manage a key in [Nexscope API Access](https://www.nexscope.ai/seller/api-access?co-from=github).
53+
Create or manage a key in [Nexscope API Access](https://www.nexscope.ai/seller/api-access?co-from=GithubAMapi).

‎scripts/validate_repository.py‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
ROOT = Path(__file__).resolve().parents[1]
1313
REQUESTS_PATH = ROOT / "examples" / "requests.json"
1414
CATALOG_PATH = ROOT / "api-catalog" / "README.md"
15+
CHANNEL_CODE = "GithubAMapi"
16+
COMPANION_REPOSITORY_URL = (
17+
f"https://github.com/nexscope-ai/nexscope-ecommerce-skills?co-from={CHANNEL_CODE}"
18+
)
1519
TEXT_SUFFIXES = {".md", ".json", ".py", ".mjs", ".sh", ".example", ".yml", ".yaml"}
1620
SLUG_RE = re.compile(r"^amazon-[a-z0-9-]+$")
1721
CJK_RE = re.compile(r"[\u3400-\u4dbf\u4e00-\u9fff\uf900-\ufaff]")
@@ -42,7 +46,7 @@ def main() -> int:
4246
if not isinstance(payload, dict):
4347
fail(f"Payload for {slug} must be a JSON object")
4448
errors += 1
45-
docs_url = f"https://www.nexscope.ai/api-docs/{slug}?co-from=github"
49+
docs_url = f"https://www.nexscope.ai/api-docs/{slug}?co-from={CHANNEL_CODE}"
4650
if docs_url not in catalog:
4751
fail(f"Catalog is missing {slug}")
4852
errors += 1
@@ -57,7 +61,12 @@ def main() -> int:
5761
fail(f"Payload file does not match requests.json for {slug}")
5862
errors += 1
5963

60-
catalog_slugs = set(re.findall(r"/api-docs/(amazon-[a-z0-9-]+)\?co-from=github", catalog))
64+
catalog_slugs = set(
65+
re.findall(
66+
rf"/api-docs/(amazon-[a-z0-9-]+)\?co-from={re.escape(CHANNEL_CODE)}",
67+
catalog,
68+
)
69+
)
6170
request_slugs = set(requests)
6271
for slug in sorted(catalog_slugs - request_slugs):
6372
fail(f"Catalog entry has no sample payload: {slug}")
@@ -75,6 +84,13 @@ def main() -> int:
7584
fail(f"Possible {label} found in {path.relative_to(ROOT)}")
7685
errors += 1
7786
if path.suffix == ".md":
87+
for url in re.findall(r"https://www\.nexscope\.ai/[^\s)>]*", text):
88+
if f"co-from={CHANNEL_CODE}" not in url:
89+
fail(
90+
f"Nexscope website URL is missing co-from={CHANNEL_CODE} "
91+
f"in {path.relative_to(ROOT)}: {url}"
92+
)
93+
errors += 1
7894
for target in re.findall(r"\]\(([^)]+)\)", text):
7995
if not target.startswith(("./", "../")):
8096
continue
@@ -90,6 +106,11 @@ def main() -> int:
90106
fail(f"Broken relative link in {path.relative_to(ROOT)}: {target}")
91107
errors += 1
92108

109+
readme = (ROOT / "README.md").read_text(encoding="utf-8")
110+
if COMPANION_REPOSITORY_URL not in readme:
111+
fail(f"README companion repository link must include co-from={CHANNEL_CODE}")
112+
errors += 1
113+
93114
if errors:
94115
print(f"Validation failed with {errors} error(s).", file=sys.stderr)
95116
return 1

0 commit comments

Comments
 (0)