Skip to content

docs(index): add apiKey to SDK initialization example - #2020

Closed
CryptAm wants to merge 1 commit into
ProjectOpenSea:mainfrom
CryptAm:patch-1
Closed

CryptAm wants to merge 1 commit into
ProjectOpenSea:mainfrom
CryptAm:patch-1

Conversation

@CryptAm

@CryptAm CryptAm commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Motivation

The OpenSeaSDK implementation example in @example (src/index.ts) does not pass the apiKey.

This is the only implementation example in the repository that omits the apiKey; fast-start.md and the JSDoc in sdk.ts include it everywhere. Without the apiKey, most API calls return an authorization error.

Solution

index.ts serves as the package entry point - for instance, on the main documentation page generated by TypeDoc. The apiKey has been added to ensure consistency with the rest of the documentation and to ensure the code works correctl

The OpenSeaSDK implementation example in `@example` (src/index.ts) does not pass the `apiKey`.

This is the only implementation example in the repository that omits the `apiKey`; `fast-start.md` and the JSDoc in `sdk.ts` include it everywhere. Without the `apiKey`, most API calls return an authorization error.

`index.ts` serves as the package entry point - for instance, on the main documentation page generated by TypeDoc. The `apiKey` has been added to ensure consistency with the rest of the documentation and to ensure the code works correctl
@ryanio

ryanio commented Oct 3, 2026

Copy link
Copy Markdown
Collaborator

Thanks @CryptAm. This repo is a read-only mirror of our monorepo, so I recreated your change there in ProjectOpenSea/opensea-devtools#784 (now merged) with you credited as co-author. It will ship in the next sdk release. Closing this one since mirror PRs can't be merged directly.

@ryanio ryanio closed this Oct 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants