API FAQs
Frequently asked questions about NYYU APIs
Frequently Asked Questions
Find answers to common questions about NYYU APIs, authentication, and integration
Getting Started
Refer to our Getting Started guide for detailed instructions on how to use our APIs. The guide covers authentication, making your first request, and best practices.
We use OAuth2 for authentication across all our APIs. You'll need to obtain an access token and include it in the Authorization header of your requests.
Authentication & Security
Obtain an OAuth2 token from your NYYU dashboard and include it in the Authorization header of your requests as Bearer YOUR_TOKEN. See the Authentication section for detailed steps.
Scopes depend on the specific API being accessed. Common scopes include "openid", "profile", and "email". Check the documentation for each endpoint to see required scopes.
Use the mutations for requesting and confirming 2FA setup. See Two-Factor Authentication documentation for implementation details.
API Endpoints & Usage
wss://api.pay.nyyu.iowss://api.node.nyyu.iohttps://api.nyyu.io/graphqlConnect to the WebSocket endpoint wss://api.pay.nyyu.io and send a JSON message with payment details including action, amount, and currency. See our payment integration guide for code examples.
Connect to the WebSocket endpoint and send a message with action "getBalance" and specify the currency (ETH, BTC, etc.). The response will include the current balance.
Rate limits vary by endpoint and authentication tier. Implement exponential backoff for rate-limited requests and monitor response headers for limit information.
User Management
Use the appropriate GraphQL mutation to update user profile details. See User Profile documentation for available mutations and examples.
Use the provided mutations for setting and updating avatar components. See Avatar Management for detailed implementation.
Follow the steps outlined in the Account Verification section, which includes sending and confirming verification codes via email or SMS.
Trading & Auctions
Use the provided mutations for placing and increasing bids. See Auction Participation for step-by-step examples and bid management.
Use the queries provided to fetch notifications with pagination support. See Notifications for filtering and management options.
Error Handling & Support
Errors are returned with appropriate HTTP status codes and error messages. Always check the response status and implement proper error handling with retry logic for transient errors.
Check our troubleshooting guide for common issues and solutions. If the problem persists, contact our developer support team with your API request details and error messages.
Refer to the Changelog section for the latest updates, changes, and deprecation notices for our APIs.
Commercial Use
Yes, NYYU APIs are designed to support both personal and commercial applications. Review our terms of service and pricing plans for commercial usage details.