Developer onboarding

Start building with Argaam APIs.

Follow a clear path from API discovery and sandbox evaluation to secure credentials, production readiness, and commercially managed access.

Live API catalog
Products and documentation
Sandbox first
Evaluate before production
Secure credentials
Application-based access
Commercial support
sales@argaam.com
Your first integration

From account to sandbox.

Explore

Review available API products and identify the right data domains.

Register

Create your developer portal account with your business information.

Create an application

Register the application that will consume Argaam APIs.

Get sandbox access

Subscribe to approved products and generate application credentials.

Your first request

Run this now. It returns data.

The live portal's Getting Started page documents this step with placeholders. Here the real base URL, the real header and a real symbol are on the page, so the first call happens before any account exists.

  • Base URL https://api.argaam.com
  • Auth header apikey, or ?apikey= on the query string
  • Demo key demo, scope-locked to 2222, 1120 and 7010
cURLShell
curl --request GET \
  --url 'https://api.argaam.com/api/v1.1/companies/2222/financials?marketId=3&period=year' \
  --header 'Accept: application/json' \
  --header 'apikey: ••••••'
Before you begin

Prepare the essentials for a smooth onboarding.

A small amount of preparation helps Argaam understand your use case and lets your team evaluate the right API products quickly.

Business account details

Use your work email and provide your company, country, role, and primary contact information.

Application information

Be ready to name your application and explain where Argaam data will be used.

Use case and expected usage

Describe the product, required data domains, target users, and expected request volume.

Integration journey

Five steps from discovery to production readiness.

Start in the catalog, validate in the sandbox, and request production access when the integration and the commercial plan are ready.

01

Explore the catalog

Review products, descriptions, versions, and documentation to find the right fit.

02

Create your account

Register with your business information and verify your portal account.

03

Register an application

Create the application that will request and consume Argaam API access.

04

Activate sandbox access

Subscribe to approved products, generate credentials, and begin controlled testing.

05

Request production

Complete validation and agree the appropriate licensing, limits, and production plan.

Access and security

Protect credentials and keep environments separate.

Authentication requirements may differ by API product. Always follow the instructions shown in the selected product documentation.

Credential security checklist

  • Keep credentials server-side. Never expose a key in browser code, a mobile binary, a repository or a log.
  • Use separate credentials. Sandbox and production keys are distinct and must stay that way.
  • Follow the product documentation. Use the authentication format documented for each API product.
  • Monitor usage and errors. Track volumes, status codes, latency and failures before production.

Environment path

Sandbox Evaluate and validate

Test authentication, responses, error handling, data mapping and application behaviour before production.

Production Commercially activated access

Use the approved production configuration, credentials, limits, and access plan.

Ready to start your integration?

Explore the catalog, validate your use case in the sandbox, and choose the plan whose rights match what you are building.